From 227c1ae67bb80a5e9b9036a9bdb9f11be073669f Mon Sep 17 00:00:00 2001 From: Ivan Dolgov Date: Sat, 16 Mar 2019 15:14:18 +0200 Subject: Initial setup --- README | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 69 insertions(+), 1 deletion(-) (limited to 'README') diff --git a/README b/README index dd47f73..187cbfe 100644 --- a/README +++ b/README @@ -1 +1,69 @@ -This will be the ick API +README for ick API +================== + +Ick API is a RESTful HTTP API/facade for [ick][] frontend(s). + +[ick]: https://ick.liw.fi/ + +Dependencies +------------ + +Ick API is written in Python 3.5 and depends on following tools and libraries: + +* [aiohttp][] +* [Gunicorn][] +* [make][] +* [pycodestyle][] +* [pydocstyle][] +* [pylint][] +* [pytest][] + +[aiohttp]: http://aiohttp.readthedocs.io/ +[Gunicorn]: http://gunicorn.org/ +[make]: https://www.gnu.org/software/make/ +[pycodestyle]: http://pycodestyle.pycqa.org/ +[pydocstyle]: http://www.pydocstyle.org/ +[pylint]: https://www.pylint.org/ +[pytest]: https://www.pytest.org/ + +Usage +----- + +FIXME + +Development +----------- + +FIXME + +Releasing +--------- + +FIXME + +Deployment +---------- + +FIXME + +License +------- + +Ick API in its entirety is copyright by its authors, and released under +the GNU Affero General Public Licence, version 3, or later. + + Ick API, a RESTful HTTP API/facade for Ick CI frontends + Copyright (C) 2019 Ivan Dolgov, Pyry Heiskanen + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . -- cgit v1.2.1