aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bc57909
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# Hydrilla&Haketilo website
+
+This is the code used by Haketilo website. A live version of the website can be
+seen at [https://haketilo.koszko.org](https://haketilo.koszko.org). There you
+can also find more information about Haketilo itself - a tool to modify pages
+opened in a web browser.
+
+## Hacking
+
+At the moment the recommended method of hacking on the website code is through
+the [GNU Guix](https://guix.gnu.org/) package manager.
+
+A Guix version of at least 1.1.0 is expected. Most development tasks have been
+automated through Makefile. Rules use the `guix time-machine` command under the
+hood to pull and run a fixed Guix version that is known to work with the
+code. Please look into the Makefile to see what rules are available.
+
+## Copying
+
+This website is Copyright (C) 2022 Wojtek Kosior and others.
+It 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 of this code in a proprietary program, I am not going to enforce this in court.*