summary refs log tree commit diff stats
path: root/pkgs/by-name/ba/back/README.md
diff options
context:
space:
mode:
authorBenedikt Peetz <benedikt.peetz@b-peetz.de>2024-12-24 01:20:31 +0100
committerBenedikt Peetz <benedikt.peetz@b-peetz.de>2024-12-24 01:20:31 +0100
commit6d3839ce151c8cb91ff95970324745a1809cab52 (patch)
tree4ec4abe9df5bdc36f2dc056b7baf9d05245510f7 /pkgs/by-name/ba/back/README.md
parentfix(pkgs/back): Set `meta.mainProgram` (diff)
downloadnixos-server-6d3839ce151c8cb91ff95970324745a1809cab52.tar.gz
nixos-server-6d3839ce151c8cb91ff95970324745a1809cab52.zip
docs(pkgs/back): Add note about needed write access
Diffstat (limited to 'pkgs/by-name/ba/back/README.md')
-rw-r--r--pkgs/by-name/ba/back/README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/pkgs/by-name/ba/back/README.md b/pkgs/by-name/ba/back/README.md
index 59f9d9a..aa9d37e 100644
--- a/pkgs/by-name/ba/back/README.md
+++ b/pkgs/by-name/ba/back/README.md
@@ -17,11 +17,15 @@ If not, see <https://www.gnu.org/licenses/agpl.txt>.
 
 ## Usage
 
-Currently `back` only visualizes a `git-bug` repository. As such it takes exactly one
+Currently, `back` only visualizes a `git-bug` repository. As such it takes exactly one
 argument, being the repository to visualize.
 The server is than started at `http://127.0.0.1:8000` and provides access to the issues
 (bugs) tracked via `git-bug`.
 
+### Note
+`back` needs write access to the repository, because of internal `gix` and `git` object
+reasons.
+
 ## Licensing
 
 This project complies with the REUSE v3.3 specification. This means that every file