Added screenshot feature: press ALT+P

In the endless struggle to squash a Travis-specific bug, we now have
screenshots. Currently the screenshots are of the custom block font
state, so you can't read the text. But I'm planning on changing the
default state of the page to use a normal font - such that the
frame builder needs to toggle the block font on to build a frame. This
will make it more likely that screenshots will contain actual text.

1 files changed, 29 insertions, 1 deletions

diff --git a/README.md b/README.md
index f1ff135..d89f6c4 100644
--- a/README.md
+++ b/README.md
@@ -38,7 +38,7 @@ a text-based web in your terminal.
 ## Installation
 
 Download a [https://github.com/tombh/browsh/releases](release) (~2MB).
-You will need to have Firefox 57+ aleady installed.
+You will need to have Firefox >=57 aleady installed.
 
 Or download and run the Docker image (~800MB) with:
     `docker run -it tombh/browsh`
@@ -48,6 +48,34 @@ Most keys and mouse gestures should work as you'd expect on a desktop
 browser.
 
 `CTRL+l` Focus URL bar
+`ALT+P` Take screenshot
+
+## Contributing
+To setup a dev env you will need NodeJS and Golang installed. If you get stuck
+setting up your env, take a look in `.travis.yml`, it has to setup everything
+from scratch for every push to Github.
+
+I'd recommend `[nvm](https://github.com/creationix/nvm)` for NodeJS - note that
+`nvm install` will automatically parse the `.nvmrc` version in this repo to get
+the correct NodeJS version. For Golang it's probably best to just use your OS's
+package manager. The current Golang version being used is stored in `.travis.yml`.
+
+You'll then need to install the project dependencies. For the webextension, just
+run: `npm install` inside the `webext/` folder. For the CLI client you will first
+need to install `dep`, there is a script for this in `interfacer/contrib/setup_go.sh`.
+I don't fully understand Golang's best practices, but it seems you are forced to
+keep your Go project's code under `$GOPATH/src`, you might be able to get away
+with symlinks. Anyway, to install the dependencies use: `dep ensure` inside the
+`interfacer/` folder.
+
+Then the ideal setup for development is:
+  * have Webpack watch the JS code so that it rebuilds automatically:
+    `webpack --watch`
+  * run the CLI client without giving it the responsibility to launch Firefox:
+    `go run ./interfacer/*.go -use-existing-ff`
+  * have Mozilla's handy `web-ext` tool run Firefox and reinstall the
+    webextension everytime webpack rebuilds it: (in `webext/dist`)
+    `web-ext run --verbose --url https://google.com`
 
 ## License
 GNU General Public License v3.0