summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeff Becker <jeff@i2p.rocks>2019-04-29 08:05:50 -0400
committerJeff Becker <jeff@i2p.rocks>2019-04-29 08:05:50 -0400
commit10d72f01e91d1754981a60ec698de846e5343e5d (patch)
treea3374472542c4027175e3678ec4d448cf9019f12
parente68e34d5780e88412432357d129d5a3ec55de24b (diff)
update readme
-rw-r--r--README.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/README.md b/README.md
index 9d1480f..cfc65de 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,10 @@
# bit-chan daemon
-intro:
+## intro
bittorrent 2.0 based imageboard software
-prereq:
+## prereq
* postgresql
* nginx
@@ -15,11 +15,15 @@ prereq:
* libssl
* ninja (suggested)
-obtain source:
+## obtain source
+
+this repo is recursive, make sure to clone it recursively
$ git clone --recursive https://git.i2p.rocks/jeff/bit-chan-daemon $HOME/git/bcd
-building:
+## building
+
+build the daemon with cmake and ninja to go fast
$ mkdir -p /tmp/bcd-build
$ cd /tmp/bcd-build