add small readmeHEADmaster

1 files changed, 18 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e4cd8f9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# LibreCalx
+
+## How to build
+
+### Debugging
+```sh
+$ cargo build
+```
+### Release
+```sh
+$ cargo build --release
+```
+
+
+## Run directly
+```sh
+$ cargo run [--release]
+```