From 8bd4f9716bfc3247b979b960817d4e049ba9e44f Mon Sep 17 00:00:00 2001
From: ef3d0c3e <ef3d0c3e@pundalik.org>
Date: Thu, 25 Jul 2024 14:20:55 +0200
Subject: [PATCH] Update Readme

---
 README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a08ca5f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+# NML -- Not a markup language!
+
+Currently a work in progress, expect features and fixes to arrive soon!
+
+# Requirements
+
+Some features requires external dependencies to work.
+
+## LaTeX rendering for HTML
+
+We ship a modified version of `latex2svg` by Matthias C. Hormann.
+The modified program can be found in [third/latex2svg](third/latex2svg) and is licensed under MIT.
+
+The installation instructions specified on [latex2svg's repository](https://github.com/Moonbase59/latex2svg).
+
+## Graphviz rendering
+
+To render Graphviz graph `[graph]...[/graph]`
+You need to install the `dot` program from [Graphviz](https://graphviz.org/) in order to render graphs.
+
+## Lua kernels
+
+To execute Lua kernels you need to install `liblua` version 5.4.
+Support for a statically linked Lua may be added in the future.
+
+# Compiling
+
+```
+cargo build --release --bin nml
+```
+
+# Features roadmap
+
+ - [x] Paragraphs
+ - [x] LaTeX rendering
+ - [x] Graphviz rendering
+ - [x] Media
+ - [ ] References
+ - [ ] Complete Lua api
+ - [ ] Documentation
+ - [ ] Table
+ - [ ] LaTeX output
+ - [ ] LSP
+
+# License
+
+NML is licensed under the GNU AGPL version 3 or later. See [LICENSE.md](LICENSE.md) for more information.
+License for third-party dependencies can be accessed via `cargo license`