aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorlthms <contact@thomasletan.fr>2017-12-27 22:10:05 +0000
committerThomas Letan <contact@thomasletan.fr>2018-01-24 08:11:24 +0100
commit150bc669e0434b6693a0d02309173eac986dd33c (patch)
treeda5cf73aa744190c3e99104e924de0c07fd42551
parentchore: lkn is using pijul and only pijul (diff)
chore: Fix READMEs
-rw-r--r--README4
-rw-r--r--README.md25
2 files changed, 27 insertions, 2 deletions
diff --git a/README b/README
index 65c135b..2d2da00 100644
--- a/README
+++ b/README
@@ -35,5 +35,5 @@ Table of Contents
to Hex.mp and so will be your contributions if they find their way
to the master branch.
- [3] https://nest.pijul.com/lthms/lkn-core
- [3] https://pijul.org
+ [1] https://nest.pijul.com/lthms/lkn-core
+ [2] https://pijul.org
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0e7a06e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# lkn-core
+
+## Overview
+
+lkn-core is a framework for creating game servers. It is written in Elixir and
+implements a home-grown ECS supervisor tree and a mechanism to dynamically spawn
+new instances for incoming players whenever it is necessary.
+
+## Contributing
+
+lkn-core is a Free Software distributed under the terms of the AGPLv3+
+License. The codebase is mainly hosted [at the
+Nest](https://nest.pijul.com/lthms/lkn-core), using the [pijul
+vcs](https://pijul.org).
+
+If you want to submit a patch, feel free to do so in the manner you find the
+more appropriate. For instance, you can:
+
+* send me a patch using the Nest (pijul)
+* send me an email with your (binary) patches
+
+The most important thing is: by providing me a patch, you agree it may become
+available to the lkn-core users under the terms of the AGPLv3+
+license. Moreover, consider lkn-core will soon be published to Hex.mp and so
+will be your contributions if they find their way to the master branch.