aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDrew DeVault <sir@cmpwn.com>2020-04-29 09:52:30 -0400
committerDrew DeVault <sir@cmpwn.com>2020-04-29 09:52:30 -0400
commit791ca4bceb2f636312d0f55caa5e5003796072c3 (patch)
treec3ad7b3be52e4026581ac4717e565602b670c92a /README.md
parentce9692cb5cd76998bb15d8f1d5b6f2ca979fea05 (diff)
downloadsr.ht-docs-791ca4bceb2f636312d0f55caa5e5003796072c3.tar.gz
Add README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1a0ee69
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# sourcehut
+
+This is the main project hub for SourceHut itself. To browse our source code,
+see the "sources" tab at the nav along the top of the page.
+
+## Getting started with SourceHut
+
+For tutorials and documentation, see [man.sr.ht](https://man.sr.ht), or click
+"man" along the nav at the top.
+
+## Deploying SourceHut yourself
+
+To install SourceHut on your own hardware, see
+[man.sr.ht/installation.md](https://man.sr.ht/installation.md)
+
+## Getting help
+
+Support is available via the
+[sr.ht-discuss](https://lists.sr.ht/~sircmpwn/sr.ht-discuss) mailing list, on
+IRC at #sr.ht on irc.freenode.net, or by emailing the admin (sir@cmpwn.com)
+directly &mdash; the latter is usually best for account or billing issues.
+
+## Contributing to SourceHut
+
+We welcome third-party patches. If you have any changes you'd like to make to
+SourceHut, please send a patch to the
+[sr.ht-dev](https://lists.sr.ht/~sircmpwn/sr.ht-dev) mailing list. Feel free to
+start discussions about development here as well, if your change requires some
+thought before writing the code.