Skip to content

Commit

Permalink
added rebuild & contribution instruction to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Eik-S committed Feb 20, 2019
1 parent 838e323 commit 0cd72e6
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,11 @@
# local-backup-server
Nodejs server for local backups of the memex browser extension.
Nodejs server for local backups of the memex browser extension.

## installation
Get the newest [release](https://github.com/WorldBrain/local-backup-server/releases) for your platform.

## rebuild & contribution
1. clone master to your local drive
2. make sure [node.js](https://nodejs.org/en/) 9 is installed on your machine
3. install the dependencies by running `npm install`
4. get the [nw.js binary](https://nwjs.io)
5. run the project by running `/path/to/nwjs-binary .` from the projects folder

0 comments on commit 0cd72e6

Please sign in to comment.