SelfPrivacy
/
selfprivacy-rest-api
mirror of https://git.selfprivacy.org/SelfPrivacy/selfprivacy-rest-api.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs(api): use title case in README

This commit is contained in:
Houkime 2024-03-18 12:00:33 +00:00 committed by Inex Code
parent 677ed27773
commit 97960f77f2
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -2,7 +2,7 @@
![CI status](https://ci.selfprivacy.org/api/badges/SelfPrivacy/selfprivacy-rest-api/status.svg) ![CI status](https://ci.selfprivacy.org/api/badges/SelfPrivacy/selfprivacy-rest-api/status.svg)
## build ## Build
```console ```console
$ nix build $ nix build
@ -10,7 +10,7 @@ $ nix build
In case of successful build, you should get the `./result` symlink to a folder (in `/nix/store`) with build contents. In case of successful build, you should get the `./result` symlink to a folder (in `/nix/store`) with build contents.
## develop ## Develop
```console ```console
$ nix develop $ nix develop
@ -26,7 +26,7 @@ If you don't have experimental flakes enabled, you can use the following command
nix --extra-experimental-features nix-command --extra-experimental-features flakes develop nix --extra-experimental-features nix-command --extra-experimental-features flakes develop
``` ```
## testing ## Testing
Run the test suite by running coverage with pytest inside an ephemeral NixOS VM with redis service enabled: Run the test suite by running coverage with pytest inside an ephemeral NixOS VM with redis service enabled:
```console ```console
@ -63,7 +63,7 @@ $ TMPDIR=".nixos-vm-tmp-dir" nix run .#checks.x86_64-linux.default.driverInterac
Option `-L`/`--print-build-logs` is optional for all nix commands. It tells nix to print each log line one after another instead of overwriting a single one. Option `-L`/`--print-build-logs` is optional for all nix commands. It tells nix to print each log line one after another instead of overwriting a single one.
## dependencies and dependant modules ## Dependencies and Dependant Modules
This flake depends on a single Nix flake input - nixpkgs repository. nixpkgs repository is used for all software packages used to build, run API service, tests, etc. This flake depends on a single Nix flake input - nixpkgs repository. nixpkgs repository is used for all software packages used to build, run API service, tests, etc.
@ -87,6 +87,6 @@ $ nix flake metadata git+https://git.selfprivacy.org/SelfPrivacy/selfprivacy-nix
Nix code for NixOS service module for API is located in NixOS configuration repository. Nix code for NixOS service module for API is located in NixOS configuration repository.
## troubleshooting ## Troubleshooting
Sometimes commands inside `nix develop` refuse to work properly if the calling shell lacks `LANG` environment variable. Try to set it before entering `nix develop`. Sometimes commands inside `nix develop` refuse to work properly if the calling shell lacks `LANG` environment variable. Try to set it before entering `nix develop`.