updated readme

danfragoso · Nov 1, 2019 · 8ecf238 · 8ecf238
1 parent b75e35f
commit 8ecf238
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -9,3 +9,30 @@ This is the hotdog web browser, it's a web browser written from scratch entirely
 - mayo (css parser, stylesheet and layout calculator)
 - mustard (browser UI, window and renderer)
 - sauce (requests, cache and filesystem)
+
+### Getting started
+- Running 
+
+  ```sh
+  make
+  ```
+  This command will start the browser and load an example page
+
+- Testing
+
+  ```sh
+  make test
+  ```
+  This command will run all the configurated unit tests
+
+- Building
+
+  ```sh
+  make build
+  ```
+  This command will build the binary and move it to the bin/ folder
+
+### Screenshot
+<p align="center">
+  <img src="screenshot.png?raw=true"></img>
+</p>
diff --git a/screenshot.png b/screenshot.png