uhk/agent
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Remove duplicate text which is already present in CONTRIBUTING.md

Browse Source 
Also add npm version requirement.
This commit is contained in:
László Monda
2016-08-30 18:21:58 +02:00
committed by GitHub
parent 3fa50827eb
commit 8b5b157737
1 changed files with 4 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -8,7 +8,7 @@ Agent is the configuration application of the [Ultimate Hacking Keyboard](https:
## Set up instructions
First up, make sure that Node.js 4.x.x is installed on your system.
First up, make sure that node >=4.x.x and npm >=3.x.x is installed on your system.
```
git clone git@github.com:UltimateHackingKeyboard/agent.git
@@ -18,14 +18,8 @@ npm run build sass
npm run dev
```
Webpack dev server exposes Agent at `localhost:8080`
At this point, webpack dev server should expose Agent at `localhost:8080`
## Contribute
## Contributing
Contributors are most welcome and appreciated beyond words!
1. Please pick an [issue](https://github.com/UltimateHackingKeyboard/agent/issues) of your interest, or open a new one.
2. Let us know in the issue what you're about to do.
3. We let you know if somebody is already working on the issue, and thank you for being awesome for considering to contribute.
4. Send a pull request of your contribution. You're welcome to send the PR early on even if it's incomplete. This way, we'll be able to provide early feedback which will save time for everyone involved.
5. Fix your PR if needed, and make sure that it passes continuous integration tests. If everything looks good we'll merge your PR, and pop a bottle of champagne to celebrate you!
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for more info about contributing.