diff options
Diffstat (limited to '')
| -rw-r--r-- | README.md | 89 |
1 files changed, 89 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..1e6d703 --- /dev/null +++ b/README.md @@ -0,0 +1,89 @@ +<h3 align="center"><img src="https://raw.githubusercontent.com/mcpcpc/kirc/master/.github/kirc.png" alt="logo" height="170px"></h3> +<p align="center">KISS for IRC, a tiny IRC client written in POSIX C99.</p> +<p align="center"> +<a href="./LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg"></a> +<a href="https://github.com/mcpcpc/kirc/releases"><img src="https://img.shields.io/github/v/release/mcpcpc/kirc.svg"></a> +<a href="https://repology.org/metapackage/kirc"><img src="https://repology.org/badge/tiny-repos/kirc.svg" alt="Packaging status"></a> +</p> + + +## 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 +<message> Send a message to the current channel. +/m <nick|channel> <message> Send a message to a specified channel or nick. +/M <message> Send a message to NickServ. +/Q <message> Send a message and close the host connection. +/x <message> Send a message directly to the server. +/j <channel> Join a specified channel. +/p <channel> 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 +----------- + + + +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 +``` |