diff options
| author | Michael Czigler <37268479+mcpcpc@users.noreply.github.com> | 2020-09-03 09:26:24 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-09-03 09:26:24 -0400 |
| commit | 262f07b2a7757509813712592d4a08a6d05054a8 (patch) | |
| tree | e133ece85e3e27cffa6e70b33af8457f04b16798 /README | |
| parent | Delete PKGBUILD (diff) | |
| download | kirc-262f07b2a7757509813712592d4a08a6d05054a8.tar.gz kirc-262f07b2a7757509813712592d4a08a6d05054a8.tar.bz2 kirc-262f07b2a7757509813712592d4a08a6d05054a8.tar.xz kirc-262f07b2a7757509813712592d4a08a6d05054a8.tar.zst kirc-262f07b2a7757509813712592d4a08a6d05054a8.zip | |
Add objectives and AUR install instructions
Diffstat (limited to 'README')
| -rw-r--r-- | README | 42 |
1 files changed, 35 insertions, 7 deletions
@@ -7,8 +7,26 @@ BACKGROUND ---------- After having tried multiple IRC clients, I decided to develope my own. The -result is a portable <250 sloc application that has no dependencies other -than a C99 compiler. +result is a portable application that has no dependencies other than a C99 +compiler. + + +OBJECTIVES +---------- + +- Per the UNIX philosophy, "Do one thing and do it well" [3]. +- True to the KISS principle [4], the code-base is intentionally smaller + than most IRC clients (<250 sloc). The benefits of a small code base + reflects in the ability for kirc to be reviewed, understood and + maintained by a single person. Therefore, all feature requests and + commits shall be considered with respect to the readability and + maintainance of the overall project. +- Let's not "reinvent the wheel". Commands and functionality should + feel familiar (e.g. vi command shortcuts) and accessable via a + standard 104-key US QWERTY keyboard layout [5]. Where possible, the + number of keystrokes shall be minimized per command. + + FEATURES @@ -34,6 +52,17 @@ FEATURES INSTALLATION ------------ +Building and installing on KISS Linux using the Community repository [2]: + + kiss b kirc + kiss i kirc + +Building and installing on Arch Linux using the AUR [6]: + + git clone https://aur.archlinux.org/kirc-git.git + cd kirc + makepkg -si + Building and installing from source: git clone https://github.com/mcpcpc/kirc.git @@ -41,11 +70,6 @@ Building and installing from source: make make install -Building and installing using KISS Linux Community repository [2]: - - kiss b kirc - kiss i kirc - USAGE ----- @@ -72,3 +96,7 @@ REFERENCES [0] https://tools.ietf.org/html/rfc2812 [1] https://en.wikipedia.org/wiki/ANSI_escape_code [2] https://github.com/kisslinux/community +[3] https://en.wikipedia.org/wiki/Unix_philosophy +[4] https://en.wikipedia.org/wiki/KISS_principle +[5] https://en.wikipedia.org/wiki/Keyboard_layout +[6] https://aur.archlinux.org/packages/kirc-git/ |