From d5f732f47c0e78ce497f7a722706d1702e898a8e Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Sun, 2 Apr 2017 14:26:05 +0300 Subject: Add README --- README | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..fd21b21 --- /dev/null +++ b/README @@ -0,0 +1,45 @@ +distixapi - an online API to a distix repository +============================================================================= + +Introduction +----------------------------------------------------------------------------- + +distix is a distributed ticketing system based on email and git. +distixapi is (or will be) an HTTP based RESTful API to a distix ticket +repository, on top of which an interactive web application for +reading, managing tickets can be built. + + +Hacking +----------------------------------------------------------------------------- + +distix is written in Python 2 (do not ask for Python 3, it will happen +when it happens). + +There are no unit tests yet. + +There are some integration tests written for the controller's HTTP +API. To run them, run `./check`. You may add any command line +parameters than `yarn` accepts. + + +Legalese +----------------------------------------------------------------------------- + +While distixapi itself is under the AGPL3+ license (see below), this +license does NOT apply to clients of the HTTP API it provides. + +Copyright 2017 Lars Wirzenius + +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