[add] readme
Christian Fraß commited on 2021-11-19 00:18:29
Zeige 1 geänderte Dateien mit 22 Einfügungen und 0 Löschungen.
- readme.md 0000000..91ae64f
| ... | ... |
@@ -0,0 +1,22 @@ |
| 1 |
+# Information |
|
| 2 |
+ |
|
| 3 |
+A simple mediator between an IRC server and a web application |
|
| 4 |
+ |
|
| 5 |
+ |
|
| 6 |
+# Building |
|
| 7 |
+ |
|
| 8 |
+## Requirements |
|
| 9 |
+ |
|
| 10 |
+- TypeScript compiler |
|
| 11 |
+- GNU Make |
|
| 12 |
+ |
|
| 13 |
+ |
|
| 14 |
+## Procedure |
|
| 15 |
+ |
|
| 16 |
+- run `tools/build` |
|
| 17 |
+ |
|
| 18 |
+ |
|
| 19 |
+# Running |
|
| 20 |
+ |
|
| 21 |
+After building just execute `build/irc-web-backend`! |
|
| 22 |
+ |
|
| 0 | 23 |