aboutsummaryrefslogtreecommitdiffstats
path: root/hacking.md
diff options
context:
space:
mode:
authorJason Phan <jason@ket.so>2020-11-02 12:37:28 -0600
committerDrew DeVault <sir@cmpwn.com>2020-11-17 09:56:08 -0500
commitf3cc1dcd596b7a4d77e5dfcca0b4413a97ec882a (patch)
tree109a9c6befcb0278559f158fe5d61d27b773d39f /hacking.md
parentb201f05d921994c455af215b54fdccda45ceb9b3 (diff)
downloadsr.ht-docs-f3cc1dcd596b7a4d77e5dfcca0b4413a97ec882a.tar.gz
Update top-level installation/configuration pages
Diffstat (limited to 'hacking.md')
-rw-r--r--hacking.md27
1 files changed, 13 insertions, 14 deletions
diff --git a/hacking.md b/hacking.md
index 5a21f2d..7c00e75 100644
--- a/hacking.md
+++ b/hacking.md
@@ -3,23 +3,22 @@ title: Hacking on SourceHut
toc: false
---
-For developers interested in hacking on SourceHut, an expedited installation
-procedure is available. The bare minimum is a PostgreSQL database and a Redis
-server, and you can generally skip the webhooks daemons unless you need them.
-It is recommended that you still use our distribution packages to obtain the
-dependencies, though.
+This document provides information for those interested in hacking on or
+contributing to SourceHut.
-If you don't intend to work on core.sr.ht, install the package to skip this
-step. If you don't intend to work on meta.sr.ht, it may be easier to install the
-package and configure it normally on localhost than to try and get it up and
-running from source.
+# Installation
-You can also *usually* get away without configuring the outgoing mail settings,
-but you may still have to generate a PGP key to get things started up. You can
-also skip the reverse proxy and use our development servers via `python3
-run.py`.
+Here are some tips to expedite the installation procedure:
-# Sending patches
+* A PostgreSQL database and Redis server are always required.
+* Generally, you can skip the webhooks daemons unless you need them.
+* Always prefer package installations for obtaining dependencies.
+* You can *usually* get away without configuring the outgoing mail settings,
+ but you may still have to generate a PGP key to get things started up.
+* You can skip setting up a reverse proxy and use our development servers via
+ `python3 run.py` instead.
+
+# Sending Patches
We use [git send-email](https://git-send-email.io) and discuss patches (and
other development topics) on the