|
|
@@ -1,5 +1,7 @@
|
|
1
|
1
|
# Sparrow
|
|
2
|
2
|
|
|
|
3
|
+[](https://jenkins.brendanabolivier.com/job/Sparrow/)
|
|
|
4
|
+
|
|
3
|
5
|
Sparrow is a front-end forum software using a [Matrix](https://matrix.org) homeserver
|
|
4
|
6
|
as its back-end. This means that, as long as you have a homeserver set up somewhere,
|
|
5
|
7
|
hosting Sparrow will only consist in serving its front-end content and pointing it
|
|
|
@@ -16,6 +18,15 @@ and the current performances of the Matrix public rooms directory computation in
|
|
16
|
18
|
This project is still under heavy development, and might change in a drastic way
|
|
17
|
19
|
without any warning. It is far from being ready for production.
|
|
18
|
20
|
|
|
|
21
|
+## Build
|
|
|
22
|
+
|
|
|
23
|
+```bash
|
|
|
24
|
+git clone https://github.com/babolivier/sparrow
|
|
|
25
|
+cd sparrow
|
|
|
26
|
+npm install
|
|
|
27
|
+npm run build
|
|
|
28
|
+```
|
|
|
29
|
+
|
|
19
|
30
|
## Contribute
|
|
20
|
31
|
|
|
21
|
32
|
Coming soon (even though I hate READMEs saying that)...
|
