summaryrefslogtreecommitdiff
path: root/content/forge/setup.md
diff options
context:
space:
mode:
authorRunxi Yu <me@runxiyu.org>2025-04-05 14:39:58 +0800
committerRunxi Yu <me@runxiyu.org>2025-04-05 14:39:58 +0800
commit3584c3480f4d282e5044ee2b1200c631e28c3fa6 (patch)
treee2f63081569ce748810f8388339c4e9edfbc4004 /content/forge/setup.md
parentRemove old code style guide (diff)
downloadwebsite-3584c3480f4d282e5044ee2b1200c631e28c3fa6.tar.gz
website-3584c3480f4d282e5044ee2b1200c631e28c3fa6.tar.zst
website-3584c3480f4d282e5044ee2b1200c631e28c3fa6.zip
Update forge docs
Diffstat (limited to '')
-rw-r--r--content/forge/setup.md26
1 files changed, 20 insertions, 6 deletions
diff --git a/content/forge/setup.md b/content/forge/setup.md
index 37be79c..d2686a1 100644
--- a/content/forge/setup.md
+++ b/content/forge/setup.md
@@ -2,27 +2,41 @@
title: Setup
---
+## System requirements
+
+We currently only support Linux and FreeBSD. Support for other UNIX-like
+operating systems may be added in the future, but we do not have any plans to
+support Windows.
+
## Build dependencies
* Git
* GNU Make
* C compiler
* Recent Go toolchain
+* [libgit2](https://libgit2.org)
+* A recent [mandoc](https://mandoc.bsd.lv)
+ (we recommend using the latest CVS checkout)
-## Build and install
-
-Clone the source code and run `make`.
+## Build
-Then run `make install` to install it. By default, it installs to `/usr/local/`.
+Clone the source code and run `gmake`.
Note that setting `GOARCH` to cross compile does not completely work, since the
-hooks handler is written in C. You need to customize `CC` to point to a proper
-cross compiler.
+hooks handler and Git RPC daemon is written in C. You need to customize `CC` to
+point to a proper cross compiler.
+
+## Install
+
+We don't provide an `install` target yet, so just copy the files to reasonable
+locations.
## Runtime dependencies
* Git
* PostgreSQL 14 or later
+* [libgit2](https://libgit2.org)
+* A runtime copy of your C library, if you are not statically linking
## Configuration