From 884d52249a4a061dcd5957ae59613aad8cf6afc1 Mon Sep 17 00:00:00 2001 From: Fuwn Date: Tue, 18 May 2021 11:58:19 -0700 Subject: feat(readme): create --- README.rst | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 README.rst diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..942dac4 --- /dev/null +++ b/README.rst @@ -0,0 +1,41 @@ +🗃 Records +========== + +What? +----- + +Records is nothing too special, it's just a simple place to host my "records". + +Getting up and running +---------------------- + +Building +^^^^^^^^ + +With Nix +"""""""" + +.. code-block:: shell + + $ nix-build + + +With Nix (Docker) +""""""""""""""""" + +.. code-block:: shell + + $ nix-build docker.nix + + +Without Nix +""""""""""" + +.. code-block:: shell + + $ cargo build --release + +License +------- + +`GNU General Public License v3.0 <./LICENSE>`_ -- cgit v1.2.3