Skip to content

Commit 262f07b

Browse files
authored
Add objectives and AUR install instructions
1 parent bf41604 commit 262f07b

File tree

1 file changed

+35
-7
lines changed

1 file changed

+35
-7
lines changed

README

Lines changed: 35 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,26 @@ BACKGROUND
77
----------
88

99
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+
1230

1331

1432
FEATURES
@@ -34,18 +52,24 @@ FEATURES
3452
INSTALLATION
3553
------------
3654

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+
3766
Building and installing from source:
3867

3968
git clone https://github.com/mcpcpc/kirc.git
4069
cd kirc
4170
make
4271
make install
4372

44-
Building and installing using KISS Linux Community repository [2]:
45-
46-
kiss b kirc
47-
kiss i kirc
48-
4973

5074
USAGE
5175
-----
@@ -72,3 +96,7 @@ REFERENCES
7296
[0] https://tools.ietf.org/html/rfc2812
7397
[1] https://en.wikipedia.org/wiki/ANSI_escape_code
7498
[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

Comments
 (0)