aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFuwn <[email protected]>2022-03-24 10:15:13 +0000
committerFuwn <[email protected]>2025-06-09 07:46:13 +0000
commit3f3ba784f685cad3fbff40f279929877bac8134e (patch)
tree9b028725daa0405dea8bd6a7bb9f17401ac327a0 /README.md
parentchore: remove publish lock (diff)
downloaddivina-3f3ba784f685cad3fbff40f279929877bac8134e.tar.xz
divina-3f3ba784f685cad3fbff40f279929877bac8134e.zip
docs(readme): rest to markdown
Diffstat (limited to 'README.md')
-rw-r--r--README.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..950c97a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+# 🎀 Divina
+
+## What?
+
+Divina is a modern build system for assembly.
+
+## Why should I use Divina?
+
+Divina is
+
+- Simple,
+- cool,
+- fast,
+- and uses Lua as a configuration language!
+
+## Getting up and Running
+
+### Install from [crates.io](https://crates.io)
+
+```shell
+$ cargo +nightly install divina
+```
+
+### Download from releases
+
+Prebuilt binaries for x86_64-based Linux systems are available in the
+[releases](https://github.com/divinaland/Divina/releases/latest). If you are using
+a different operating system or architecture such as Windows or macOS, you'll have
+to build and install the tool yourself!
+
+### Install from self-compile
+
+```shell
+$ cargo +nightly install --git https://github.com/divinaland/Divina --branch main
+```
+
+If you are building and installing yourself, you must have
+[Rust](https://www.rust-lang.org/) installed!
+
+## Usage
+
+Usage documentation is available on [divina.land](https://divina.land)
+
+## Examples
+
+[`examples/`](./examples)
+
+## License
+
+[GNU General Public License v3.0](./LICENSE)