about summary refs log tree commit diff
path: root/tools/govanity/README.org
diff options
context:
space:
mode:
authorFranck Cuny <franck@fcuny.net>2022-05-29 09:25:11 -0700
committerFranck Cuny <franck@fcuny.net>2022-05-29 09:25:11 -0700
commitf3a1d10b2c5df68835f86082cfb722ae679190ff (patch)
treeab29190a9e513380ff55b297c4ee58be41a70d12 /tools/govanity/README.org
parentfix(cgit): write the test correctly (diff)
parentremove unused Makefile (diff)
downloadworld-f3a1d10b2c5df68835f86082cfb722ae679190ff.tar.gz
Merge remote-tracking branch 'govanity/main'
Change-Id: I4fd7c748648415db1fa9baaa048ba51e186ec268
Diffstat (limited to 'tools/govanity/README.org')
-rw-r--r--tools/govanity/README.org15
1 files changed, 15 insertions, 0 deletions
diff --git a/tools/govanity/README.org b/tools/govanity/README.org
new file mode 100644
index 0000000..7955ead
--- /dev/null
+++ b/tools/govanity/README.org
@@ -0,0 +1,15 @@
+A service to manage vanity URLs for go packages.
+
+It makes it possible to install tools like this:
+#+begin_src sh
+GOPRIVATE=1 go install -v golang.fcuny.net/tools/cmd/music-organizer@latest
+#+end_src
+
+* Build
+Running =nix build= in the repository will create the binary.
+* Run
+Running =nix run= in the repository will start the server.
+* Deployment
+To update the application with the most recent code, run =make deploy=.
+* Configuration
+Add repositories to the [[file+sys:vanity.yaml][configuration file]].