@@ -7,8 +7,26 @@ BACKGROUND
7
7
----------
8
8
9
9
After having tried multiple IRC clients, I decided to develope my own. The
10
- result is a portable <250 sloc application that has no dependencies other
11
- than a C99 compiler.
10
+ result is a portable application that has no dependencies other than a C99
11
+ compiler.
12
+
13
+
14
+ OBJECTIVES
15
+ ----------
16
+
17
+ - Per the UNIX philosophy, "Do one thing and do it well" [3].
18
+ - True to the KISS principle [4], the code-base is intentionally smaller
19
+ than most IRC clients (<250 sloc). The benefits of a small code base
20
+ reflects in the ability for kirc to be reviewed, understood and
21
+ maintained by a single person. Therefore, all feature requests and
22
+ commits shall be considered with respect to the readability and
23
+ maintainance of the overall project.
24
+ - Let's not "reinvent the wheel". Commands and functionality should
25
+ feel familiar (e.g. vi command shortcuts) and accessable via a
26
+ standard 104-key US QWERTY keyboard layout [5]. Where possible, the
27
+ number of keystrokes shall be minimized per command.
28
+
29
+
12
30
13
31
14
32
FEATURES
@@ -34,18 +52,24 @@ FEATURES
34
52
INSTALLATION
35
53
------------
36
54
55
+ Building and installing on KISS Linux using the Community repository [2]:
56
+
57
+ kiss b kirc
58
+ kiss i kirc
59
+
60
+ Building and installing on Arch Linux using the AUR [6]:
61
+
62
+ git clone https://aur.archlinux.org/kirc-git.git
63
+ cd kirc
64
+ makepkg -si
65
+
37
66
Building and installing from source:
38
67
39
68
git clone https://github.com/mcpcpc/kirc.git
40
69
cd kirc
41
70
make
42
71
make install
43
72
44
- Building and installing using KISS Linux Community repository [2]:
45
-
46
- kiss b kirc
47
- kiss i kirc
48
-
49
73
50
74
USAGE
51
75
-----
@@ -72,3 +96,7 @@ REFERENCES
72
96
[0] https://tools.ietf.org/html/rfc2812
73
97
[1] https://en.wikipedia.org/wiki/ANSI_escape_code
74
98
[2] https://github.com/kisslinux/community
99
+ [3] https://en.wikipedia.org/wiki/Unix_philosophy
100
+ [4] https://en.wikipedia.org/wiki/KISS_principle
101
+ [5] https://en.wikipedia.org/wiki/Keyboard_layout
102
+ [6] https://aur.archlinux.org/packages/kirc-git/
0 commit comments