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

Update README.md (#88)

Browse Source
This commit is contained in:
László Monda
2016-08-28 20:33:56 +02:00
committed by GitHub
parent 25a53df891
commit 875dbb9526
1 changed files with 35 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@@ -4,14 +4,11 @@
Agent is the configuration application of the [Ultimate Hacking Keyboard](https://ultimatehackingkeyboard.com/).
Agent is in a preliminary state. You can click around, and most interactions will loosely work, but the application is not production ready yet. Agent is being ported to Angular 2 after which its features will actually fully work as expected.
[Give it a whirl!](http://ultimatehackingkeyboard.github.io/agent/)
## Set up instructions
Prerequisite: Install Node.js <br/>
Verify that you are running at least node v4.x.x and npm 3.x.x by running node -v and npm -v in a terminal/console window. Older versions produce errors.
First up, make sure that Node.js 4.x.x is installed on your system.
```
git clone git@github.com:UltimateHackingKeyboard/agent.git
@@ -21,8 +18,40 @@ npm run build
npm run webpack-dev-server
```
The agent will be hosted on `localhost:8080`.
Webpack dev server exposes Agent at `localhost:8080`
## Contribute
Contributions are most welcome! Please always try to be as consistent as possible. Always run `npm run lint` and resolve lint warnings before every commit.
Contributions are most welcome and appreciated beyond words!
1. Please pick an [issue](![Agent logo & text](https://raw.githubusercontent.com/UltimateHackingKeyboard/agent-mockup/master/images/agent-logo-with-text.png)
[![Build Status](https://travis-ci.org/UltimateHackingKeyboard/agent.svg?branch=master)](https://travis-ci.org/UltimateHackingKeyboard/agent)
Agent is the configuration application of the [Ultimate Hacking Keyboard](https://ultimatehackingkeyboard.com/).
[Give it a whirl!](http://ultimatehackingkeyboard.github.io/agent/)
## Set up instructions
First up, make sure that Node.js 4.x.x is installed on your system.
```
git clone git@github.com:UltimateHackingKeyboard/agent.git
cd agent
npm install
npm run build
npm run webpack-dev-server
```
Webpack dev server exposes Agent at `localhost:8080`
## Contribute
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!