diff options
| author | Fuwn <[email protected]> | 2021-05-18 11:58:19 -0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2021-05-18 11:58:19 -0700 |
| commit | 884d52249a4a061dcd5957ae59613aad8cf6afc1 (patch) | |
| tree | efd087528a92bac076210786000a56913a059e38 | |
| parent | feat(records): :star: (diff) | |
| download | records-884d52249a4a061dcd5957ae59613aad8cf6afc1.tar.xz records-884d52249a4a061dcd5957ae59613aad8cf6afc1.zip | |
feat(readme): create
| -rw-r--r-- | README.rst | 41 |
1 files changed, 41 insertions, 0 deletions
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>`_ |