70e07049915b8f07d35ab7cd097615fd0506c248
Christian Fraß [add] readme

Christian Fraß authored 2 years ago

1) # Information
2) 
3) A simple IRC client, realized as web application
4) 
5) 
Christian Fraß [mod] readme

Christian Fraß authored 2 years ago

6) # Licence
7) 
8) - model: GPLv3
9) - author: svartoyg
10) 
11) 
Christian Fraß [add] readme

Christian Fraß authored 2 years ago

12) # Building
13) 
14) ## Requirements
15) 
16) - TypeScript compiler
17) - LessCSS compiler
18) - GNU Make
19) 
20) 
21) ## Procedure
22) 
23) - create a configuration file in the `conf` directory (e.g. `foobar.json`); deriving from `conf/example.json` might be a good idea
24) - run `tools/build <conf-profile>` (e.g. `tools/build foobar`)
25) 
26) 
27) # Running
28) 
29) - place the files from the `build` directory on a web server and host them
30) 
Christian Fraß [mod] readme

Christian Fraß authored 2 years ago

31) 
32) # Plans and ToDos
33) 
Christian Fraß [mod] readme

Christian Fraß authored 2 years ago

34) - use websockets instead of polling
Christian Fraß [mod] readme

Christian Fraß authored 2 years ago

35) - support commands (e.g. `/nick new_name`)
Christian Fraß [mod] minor adjustments

Christian Fraß authored 2 years ago

36) - get correct user list (seems like it does not update when a user leaves the room)
Christian Fraß [mod] readme

Christian Fraß authored 2 years ago

37) - add possibility to start query