diff options
| -rw-r--r-- | README.md | 50 | ||||
| -rw-r--r-- | README.rst | 58 |
2 files changed, 50 insertions, 58 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) diff --git a/README.rst b/README.rst deleted file mode 100644 index 9734a68..0000000 --- a/README.rst +++ /dev/null @@ -1,58 +0,0 @@ -🎀 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 <https://divina.land>`_. - -Examples -^^^^^^^^ - -.. raw:: html - - <a href="./examples"><code>examples/</code></a> - -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>`_ |