aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWojtek Kosior <koszko@koszko.org>2022-10-31 13:07:20 +0100
committerWojtek Kosior <koszko@koszko.org>2022-10-31 13:08:52 +0100
commit40d1c3c60eda25df29ecb79d5b9bf7be378c8327 (patch)
tree7e149e0b3798c819e0487459930f7751876148ba
parent3dc8d8f600d81fec02cd70d8b45cc5e650873cd5 (diff)
downloadhydrilla-website-40d1c3c60eda25df29ecb79d5b9bf7be378c8327.tar.gz
hydrilla-website-40d1c3c60eda25df29ecb79d5b9bf7be378c8327.zip
add READMe.md
-rw-r--r--README.md25
-rw-r--r--README.md.license5
2 files changed, 30 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.*
diff --git a/README.md.license b/README.md.license
new file mode 100644
index 0000000..baf2b81
--- /dev/null
+++ b/README.md.license
@@ -0,0 +1,5 @@
+SPDX-License-Identifier: CC0-1.0
+
+Copyright (C) 2022 Wojtek Kosior
+
+Available under the terms of Creative Commons Zero v1.0 Universal.