From a14ab0a7601ff5c197fe43d42410d8ed6bfd26a8 Mon Sep 17 00:00:00 2001
From: Wojtek Kosior <koszko@koszko.org>
Date: Sat, 13 Nov 2021 20:33:57 +0100
Subject: initial commit

---
 README.md | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..37d18ee
--- /dev/null
+++ b/README.md
@@ -0,0 +1,62 @@
+
+[//]: # ( SPDX-License-Identifier: CC0-1.0 )
+
+[//]: # ( Hydrilla's README file )
+
+[//]: # ( Copyright (C) 2021 Wojtek Kosior )
+
+[//]: # ( Available under the terms of Creative Commons Zero v1.0 Universal. )
+
+# Hydrilla (Python implementation)
+
+This is the repository of Python incarnation of [Hydrilla](https://hydrillabugs.koszko.org/projects/hydrilla/wiki/Wiki), a repository software to serve [Haketilo](https://hydrillabugs.koszko.org/projects/haketilo/wiki) packages.
+
+## Dependencies
+
+* flask
+* pytest (for running tests)
+
+Additionally, Hydrilla requires Python 3.
+
+## Building
+
+We're supplying debian packaging. To generate the necessary `debian.tar.gz` and `orig.tar.gz` files, run:
+``` shell
+python3 setup.py make_tarballs
+```
+
+This will generate appropriate `debian.tar.gz` and `orig.tar.gz` in the parent of the project directory.
+
+*TODO: describe debian procedure...*
+
+We're using setuptools. This means you can also do something like:
+``` shell
+python3 setup.py install
+```
+
+*TODO: describe setuptools considerations and mention avoiding pip...*
+
+## Running
+Hydrilla can be run from source, without prior installation, provided that its dependencies are present on the system. For this to work, you should first generate GNU Gettext `.mo` files. This is most easily achieved using our custom `setup.py` command:
+``` shell
+python3 setup.py msgfmt
+```
+
+A simple session can then be started with:
+``` shell
+python3 setup.py run
+```
+
+*TODO...*
+
+## Copying
+
+Hydrilla is entirely available under the GNU Affero General Public License version 3 or later. Some files might also give you broader permissions, see comments inside them.
+
+*I, Wojtek Kosior, thereby promise not to sue for violation of this project's license. Although I request that you do not make use this code in a proprietary program, I am not going to enforce this in court.*
+
+## Contributing
+
+Please visit our Redmine instance at https://hydrillabugs.koszko.org.
+
+You can also write an email to koszko@koszko.org.
\ No newline at end of file
-- 
cgit v1.2.3