From 5db8d0b6e3d8d924008eea25b7bd831ce3c53bea Mon Sep 17 00:00:00 2001 From: Michael Czigler <37268479+mcpcpc@users.noreply.github.com> Date: Mon, 7 Sep 2020 14:04:26 -0400 Subject: 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 --- README.md | 89 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 89 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..1e6d703 --- /dev/null +++ b/README.md @@ -0,0 +1,89 @@ +

logo

+

KISS for IRC, a tiny IRC client written in POSIX C99.

+

+ + +Packaging status +

+ + +## Objectives + +*"Do one thing and do it well"* — Per the [Unix philosophy](https://en.wikipedia.org/wiki/Unix_philosophy), emphasis was placed on building simple, short, clear, modular, and extensible code that can be easily maintained and repurposed. + +*Portability* — [POSIX](https://en.wikipedia.org/wiki/POSIX) compliance ensures seamless compatibility and interoperability between variants of Unix and other operating systems. + +*Usability* — Commands and shortcuts should feel natural and accessible using a [standard 104-key US keyboard layout](https://en.wikipedia.org/wiki/Keyboard_layout). Where possible, the number of keystrokes shall be minimized. + +Usage +----- + +```shell +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') +``` + +Features +-------- + +- No dependencies other than a [C99 compiler](https://gcc.gnu.org/). +- Automatic server *PING* response. +- Complies with [RFC 2812](https://tools.ietf.org/html/rfc2812) standard. +- vi-like command shortcuts: + +```shell + Send a message to the current channel. +/m Send a message to a specified channel or nick. +/M Send a message to NickServ. +/Q Send a message and close the host connection. +/x Send a message directly to the server. +/j Join a specified channel. +/p Leave (part) a specified channel. +/n List all users on the current channel. +/q Close the host connection. +``` + +- Color scheme definition via [ANSI 8-bit colors](https://en.wikipedia.org/wiki/ANSI_escape_code). Therefore, one could theoretically achieve uniform color definition across all shell applications and tools. + +Screenshots +----------- + +![Screenshot 1](/.github/example.png) + +Installation +------------ + +Building and installing on **KISS Linux** using the Community repository: + +```shell +kiss b kirc +kiss i kirc +``` + +Building and installing on **Arch Linux** or **Manjaro** using the Arch AUR: + +```shell +git clone https://aur.archlinux.org/kirc-git.git +cd kirc +makepkg -si +``` + +Building and installing from source (works on **Rasbian**, **Debian**, **Ubuntu** and many other distributions): + +```shell +git clone https://github.com/mcpcpc/kirc.git +cd kirc +make +make install +``` -- cgit v1.2.3