docs

README.md

@@ -1 +1,52 @@
-# onecommand-hs
+# OneCommand
+
+![capsule](https://capsule-render.vercel.app/api?type=waving&height=300&color=gradient&text=One%20Command)
+
+Simple Minecraft one command generator written in Haskell
+
+![overview](./docs/image0.png)
+
+## Installation
+
+### Prerequisites
+
+- Stack
+- Cabal
+- Glasgow Haskell Compiler
+
+### Installation Guide
+
+Run the following command.
+
+```bash
+stack build
+```
+
+## Usage
+
+### MCF Format
+
+`.mcf` is a simple format to define minecraft command blocks. A single `.mcf` file corresponds to a single impulse/repeating command block, which is chained by multiple chain command blocks. The format is consisted with commands delimited by lines. The first line is chain type identifier, which can be one of `!IMPULSE` or `!REPEATING`.
+
+Example of MCF
+
+```plain
+!IMPULSE
+command1
+command2
+# comment
+```
+
+### Generating
+
+To generate the one command, put all `.mcf` files in a directory. And run the executable with path pointing at the directory.
+
+```bash
+ocmd ~/my-commands
+```
+
+There's also a sample commands directory at `/sample-cmd`
+
+### Making Structure
+
+Put generated command into a impulse command block on a flat surface, in _always active_ mode. The command structure will appear immediately.