summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a4a4b60
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# gwaihir git server — how-to guide
+
+This little self-hosted git server runs on `gwaihir` (gitolite over SSH for
+push/pull, cgit over HTTPS for read-only browsing at
+[git.veltar.systems](https://git.veltar.systems)). This repo is the docs.
+
+- [Creating a new repo from scratch](creating-a-repo-from-scratch.md)
+- [Importing an existing codebase](importing-an-existing-codebase.md)
+- [Making a repo public (cgit)](making-a-repo-public.md)
+
+## The short version
+
+You (any user in the `@creators` group) can create a repo yourself, no
+admin involvement needed, under your own namespace:
+
+```
+git@git.veltar.systems:personal/<your-username>/<reponame>
+```
+
+The repo doesn't exist until your first push — that push *is* the
+creation step. It's private (SSH-only) by default. See the linked docs
+for the details, and [making-a-repo-public.md](making-a-repo-public.md)
+if you also want it browsable on the web.