aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorFuwn <[email protected]>2022-02-07 04:26:07 -0800
committerFuwn <[email protected]>2025-06-09 00:46:03 -0700
commitbfa483c6aa5db5c9825faded62176904d516faf7 (patch)
tree043b73bdd939f955f2b4d1e6309c8b697d6e0544 /README.rst
downloadarchived-divina-bfa483c6aa5db5c9825faded62176904d516faf7.tar.xz
archived-divina-bfa483c6aa5db5c9825faded62176904d516faf7.zip
feat(divina): pre-release :star:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst51
1 files changed, 51 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..f947679
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,51 @@
+🎀 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
+----------------------
+
+Installation
+^^^^^^^^^^^^
+
+Prebuilt binaries for x86_64-based Linux systems and Windows are available in the
+`releases <https://github.com/divinaland/Divina/releases/latest>`_. If you are using
+a different operating system or architecture such as macOS, you'll have to build and
+install the tool yourself!
+
+.. code-block:: shell
+
+ $ cargo 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 <divina.land>`_.
+
+Prebuilt Binaries
+"""""""""""""""""
+
+Prebuilt binaries for the latest release may be found
+`here <https://github.com/divinaland/Divina/releases/latest>`_.
+
+License
+-------
+
+`GNU General Public License v3.0 <./LICENSE>`_