diff --git a/README.rst b/README.rst index 5fb1dfc668cf9de6c6c4207684836bbe881366fa..f1552d5cec4e08d636ec9cf0ef83ea667ddfbb11 100644 --- a/README.rst +++ b/README.rst @@ -2,3 +2,34 @@ PrivateStorageio ================ The backend for a private, secure, and end-to-end encrypted storage solution + +Building +-------- + +The build system uses `Nix`_ which must be installed before anything can be built. + +Documentation +~~~~~~~~~~~~~ + +The documentation can be built using this command:: + + nix-build docs.nix + +The documentation is also built on and published by CI. + +Testing +------- + +The test system uses `Nix`_ which must be installed before any tests can be run. + +Unit tests are run using this command:: + + $ nix-build nixos/unit-tests.nix + +Unit tests are also run on CI. + +The system tests are run using this command:: + + $ nix-build nixos/system-tests.nix + +The system tests boot QEMU VMs which prevents them from running on CI at this time.