aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7918c3a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# extmc
+
+Minecraft plugin framework based on stdout and rcon.
+
+## Features
+
+* Plugin system.
+* Multithreaded.
+* Almost all settings can be reloaded at runtime.
+
+## Requirements
+
+* POSIX.1-2008 compliant system (BSD support is on the way)
+* C11 compiler
+* GNU Make
+
+## Documents
+
+To be continued (🕊️🕊️🕊️)
+
+## Install
+
+```shell
+make install
+```
+
+## Author
+
+Yuuta Liang <yuuta@yuuta.moe>
+
+## Liccense
+
+GPL v2 only.