diff options
author | Michael Czigler <37268479+mcpcpc@users.noreply.github.com> | 2020-09-07 14:04:26 -0400 |
---|---|---|
committer | mcpcpc <michaelczigler@icloud.com> | 2020-09-09 22:25:03 -0400 |
commit | 5db8d0b6e3d8d924008eea25b7bd831ce3c53bea (patch) | |
tree | 72c9bba8ec100617f5f5d6717bc5498f4e342818 /README | |
parent | Merge pull request #11 from mcpcpc/0.0.7 (diff) | |
download | kirc-5db8d0b6e3d8d924008eea25b7bd831ce3c53bea.tar.gz kirc-5db8d0b6e3d8d924008eea25b7bd831ce3c53bea.tar.bz2 kirc-5db8d0b6e3d8d924008eea25b7bd831ce3c53bea.tar.xz kirc-5db8d0b6e3d8d924008eea25b7bd831ce3c53bea.tar.zst kirc-5db8d0b6e3d8d924008eea25b7bd831ce3c53bea.zip |
Squash commits pertaining to 0.0.8 release
Update README
cleanup
cleanup
fix int typecast in printw()
fix int typecast for JOIN/QUIT
add 'x' command to send direct messages to server
Update README
Update kirc.c
remove annoying initial space char
revert last commit to remove initial space
revert last commit
undo accidental commit
apply fix for initial space char
add NAMES command
revamped README for readability in GitHub
Rename README to README.md
Update README.md
Update README.md
Update README.md
Update README.md
Update README.md
Update README.md
Update README.md
Update README.md
Update README.md
Add files via upload
Update README.md
Update README.md
Update README.md
Update README.md
Update README.md
Update README.md
Add files via upload
Update README.md
Update README.md
Update README.md
Update README.md
Update README.md
Update README.md
Update README.md
Add files via upload
Update README.md
Add files via upload
Delete example_cropped.png
Delete kirc.png
Add files via upload
Delete kirc.png
Add files via upload
Delete kirc.png
Add files via upload
Delete kirc.png
Add files via upload
Delete kirc.png
Add files via upload
Update README.md
Add files via upload
Delete example_cropped.JPG
Update README.md
Update README.md
Update README.md
Update README.md
Update README.md
Diffstat (limited to 'README')
-rw-r--r-- | README | 100 |
1 files changed, 0 insertions, 100 deletions
@@ -1,100 +0,0 @@ -kirc - -KISS for IRC, an IRC client written in POSIX C99. - - -BACKGROUND ----------- - -After having tried multiple IRC clients, I decided to develope my own. The -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 --------- - -- automatic host PING response. -- vi-like shortcuts: - - <message> send a message to the current channel - /m <nick|channel> <message> send a message to a specified nick or channel - /n <message> send a message to NickServ - /j <channel> join a specified channel - /p <channel> leave (part) a specified channel - /Q <message> send a message and close the host connection - /q close the host connection - -- automatic word wrapping using the greedy algorithm. -- color scheme definition via ANSI 8-bit colors [1]. Therefore, one could - theoretically achieve uniform color definition across all shell applications - and tools. - - -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 - cd kirc - make - make install - - -USAGE ------ - -usage: kirc [-s hostname] [-p port] [-c channel] [-n nick] [-r real name] -[-u username] [-k password] [-w columns] [-W columns] [-o path] [-v|V] --s server address (default: 'irc.freenode.org') --p server port (default: '6667') --c channel name (default: '#kisslinux') --n nickname (required) --u server username (optional) --k server password (optional) --r real name (optional) --v version information --V verbose output (e.g. raw stream) --o output path to log irc stream --w maximum width of the printed left column (default: '10') --W maximum width of the entire printed stream (default '80') - - -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/ |