diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 66 |
1 files changed, 65 insertions, 1 deletions
@@ -1 +1,65 @@ -This will be the ick web UI +Ick UI README +============= + +This is a web user interface for [Ick2][] CI system. + +[Ick2]: https://ick.liw.fi + +Dependencies +------------ + +Ick web UI is a [React][] application. Other dependencies include: + +* [Babel][] +* [ESLint][] +* [Jest][] +* [webpack][] + +To install them, you will need [npm][] (or a compatible package manager) and +[make][]: + + make install + +[React]: https://reactjs.org/ +[Babel]: https://babeljs.io/ +[ESLint]: https://eslint.org/ +[Jest]: https://facebook.github.io/jest/ +[webpack]: https://webpack.js.org/ +[npm]: https://www.npmjs.com/ +[make]: https://www.gnu.org/software/make/ + +Usage +----- + +To start development server run: + + make run + +And point your browser to `http://localhost:3000/`. + +Development +----------- + +FIXME + +License +------- + +Ick UI in its entirety is copyright by its authors, and released under the GNU +General Public License v3.0 or later. + + Ick UI - a web UI for Ick2 + Copyright (C) 2018 Ivan Dolgov + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <http://www.gnu.org/licenses/>. |