hiro/tridactyl
1
0
Fork 0
mirror of https://github.com/vale981/tridactyl synced 2025-03-04 17:11:40 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add build instructions to readme

Browse source
This commit is contained in:
Colin Caine 2017-09-25 05:25:24 +01:00
parent 9e57a25aa6
commit d8033adccc
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
readme.md
View file

@ -2,6 +2,21 @@
Replace ff's default control mechanism with one modelled on the one true editor, Vim.
## Contributing
### Building and installing
```
git clone https://github.com/cmcaine/tridactyl.git
cd tridactyl/src
npm install
./make
```
Addon is built in tridactyl/build. Load it as a temporary addon in firefox with `about:debugging` or the `web-ext` CLI (`web-ext run -s build --firefox path/to/nightly/firefox`). The addon may work in older versions of Firefox, but it's targetting Firefox 57+.
## Principles and objectives
Principles:
* Keyboard > mouse