diff options
| author | lthms <contact@thomasletan.fr> | 2017-05-12 05:26:56 +0000 |
|---|---|---|
| committer | Thomas Letan <contact@thomasletan.fr> | 2018-01-24 08:10:27 +0100 |
| commit | 31a053140deafb89d9533580a157cbfb5bc5e5e8 (patch) | |
| tree | 5dd9940095ba8ba8ac3cb3d94f03a154be7ef009 | |
| parent | chore: Add some documentation for the Component module (diff) | |
chore: write a minimalist plain text README
| -rw-r--r-- | README | 47 | ||||
| -rw-r--r-- | README.md | 1 |
2 files changed, 47 insertions, 1 deletions
@@ -0,0 +1,47 @@ + ━━━━━━━━━━━━━━━━━━━━━━ + LKN-CORE + ━━━━━━━━━━━━━━━━━━━━━━ + +Table of Contents +───────────────── +1. Overview +2. Contributing + + + +1. 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. + +2. Contributing +═══════════════ + + lkn-core is a Free Software distributed under the terms of the + AGPLv3+ License. The codebase is hosted at several locations, + including a Github repository[1] and a self-hosted + repository[2]. There also is a pijul repository[3], because I + believe using pijul for lkn is a good way to contribute to pijul + without having to write code. + + If you want to submit a patch, feel free to do so in the manner you + find the more appropriate. For instance, you can: + · open a Github pull request if you have an account. + · send me a git remote I can fetch + · send me a patch using the Nest (pijul) + · send me an email with your 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. Finally, regarding the fact that the codebase + is kept under two DVCS, know that I might create a patch of your + changes with the tool you didn't use. + + [1] https://www.github.com/lkn-org/lkn-core + [2] http://git.lthms.xyz/lkn/lkn-core + [3] https://nest.pijul.com/lthms/lkn-core diff --git a/README.md b/README.md deleted file mode 100644 index 823da75..0000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -# lkn |