Skip to content

Commit

Permalink
README updated
Browse files Browse the repository at this point in the history
  • Loading branch information
tombh committed Jun 12, 2018
1 parent fc40abd commit d3d194b
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,7 @@ Download a binary from the [releases](https://github.com/tombh/texttop/releases)
You will need to have Firefox >=57 aleady installed.

Or download and run the Docker image (~800MB) with:
`docker run -it tombh/browsh`

There's currently a known bug when running Browsh against a fresh install of Firefox.
If Browsh happens to be the first to ever open Firefox on your machine then it will
get stuck because Firefox behaves differently on its first ever launch. The simple
fix is to either just to run Browsh again, or launch Firefox manually yourself (you don't even need to keep it open).
`docker run -it tombh/texttop`

## Usage
Most keys and mouse gestures should work as you'd expect on a desktop
Expand Down Expand Up @@ -80,12 +75,14 @@ Then the ideal setup for development is:
`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`
`web-ext run --verbose`

## Tests

For the webextension: in the `webext/` folder, `npm test`
For the CLI client: in the `interfacer/` folder `./contrib/run_tests.sh`
For the webextension: in `webext/` folder, `npm test`
For CLI unit tests: in `/interfacer` run `go test src/browsh/*.go`
For CLI E2E tests: in `/interfacer` run `go test test/tty/*.go`
FOr HTTP Service tests: in `/interfacer` run `go test test/http-server/*.go`

## License
GNU General Public License v3.0

0 comments on commit d3d194b

Please sign in to comment.