Files
agent/README.md
László Monda 679e20d915 Create README.md
2017-06-12 23:10:47 +02:00

27 lines
983 B
Markdown

![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)
[![Build status](https://ci.appveyor.com/api/projects/status/4flvi969t4lgwwk6?svg=true)](https://ci.appveyor.com/project/mondalaci/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 >=4.x.x and npm >=3.x.x are installed on your system. Next up:
```
git clone git@github.com:UltimateHackingKeyboard/agent.git
cd agent
npm install
npm run build:electron
npm run electron
```
At this point, Agent should be running on your machine.
## Contributing
Wanna contribute? Please let us show you [how](CONTRIBUTING.md).