martin/nci
1
0
Fork 0
mirror of https://gitlab.silvrtree.co.uk/martind2000/nci.git synced 2025-01-10 20:45:08 +00:00
Code Issues Projects Releases Wiki Activity

add quick setup section to readme

Browse Source
This commit is contained in:
oleg 2016-02-07 10:09:34 +03:00
parent f2b4c97336
commit 0eee491edf
1 changed files with 32 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -36,8 +36,7 @@ pretty shell scripting (strings without quotes, nice multiline strings, etc)
[sample project config](./docs/sample-project-config.yaml)) [sample project config](./docs/sample-project-config.yaml))
Online demo is [here](http://classicui-ncidemo.rhcloud.com/), basic tutorial Online demo is [here](http://classicui-ncidemo.rhcloud.com/).
[here](./docs/tutorials/standalone-web-ui.md).
## System requirements ## System requirements
@ -48,6 +47,37 @@ Online demo is [here](http://classicui-ncidemo.rhcloud.com/), basic tutorial
* mercurial client >= 2.8 (only for building mercurial projects) * mercurial client >= 2.8 (only for building mercurial projects)
## Quick setup
Clone quick setup repo, go into it and install dependencies:
```sh
git clone https://github.com/node-ci/nci-quick-setup && cd nci-quick-setup && npm install
```
run nci:
```sh
node_modules/.bin/nci
```
that's all, now you can experiment with it by adding/changing projects,
use web interface (on http://127.0.0.1:3000 by default) for run project builds,
etc.
Currently web interface doesn't support adding new projects or editing of
existing projects. You have to do that by adding/editing project config
file.
See [basic tutorial](https://github.com/node-ci/nci/blob/master/docs/tutorials/standalone-web-ui.md)
for setup and usage details.
## Resources ## Resources
* [basic tutorial](./docs/tutorials/standalone-web-ui.md) * [basic tutorial](./docs/tutorials/standalone-web-ui.md)