[add] readme
Christian Fraß commited on 2021-11-19 00:18:16
Zeige 1 geänderte Dateien mit 24 Einfügungen und 0 Löschungen.
- readme.md 0000000..16e6bf5
| ... | ... |
@@ -0,0 +1,24 @@ |
| 1 |
+# Information |
|
| 2 |
+ |
|
| 3 |
+A simple IRC client, realized as web application |
|
| 4 |
+ |
|
| 5 |
+ |
|
| 6 |
+# Building |
|
| 7 |
+ |
|
| 8 |
+## Requirements |
|
| 9 |
+ |
|
| 10 |
+- TypeScript compiler |
|
| 11 |
+- LessCSS compiler |
|
| 12 |
+- GNU Make |
|
| 13 |
+ |
|
| 14 |
+ |
|
| 15 |
+## Procedure |
|
| 16 |
+ |
|
| 17 |
+- create a configuration file in the `conf` directory (e.g. `foobar.json`); deriving from `conf/example.json` might be a good idea |
|
| 18 |
+- run `tools/build <conf-profile>` (e.g. `tools/build foobar`) |
|
| 19 |
+ |
|
| 20 |
+ |
|
| 21 |
+# Running |
|
| 22 |
+ |
|
| 23 |
+- place the files from the `build` directory on a web server and host them |
|
| 24 |
+ |
|
| 0 | 25 |