aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMichael Czigler <37268479+mcpcpc@users.noreply.github.com>2020-10-08 09:12:55 -0400
committerGitHub <noreply@github.com>2020-10-08 09:12:55 -0400
commit95f0b9d054f994ce9ba7ef1076be6ed4f964e33a (patch)
tree94c2d2e2bb17c8debe7e44904805dc78921136d3 /README.md
parentremove extra external links (diff)
downloadkirc-95f0b9d054f994ce9ba7ef1076be6ed4f964e33a.tar.gz
kirc-95f0b9d054f994ce9ba7ef1076be6ed4f964e33a.tar.bz2
kirc-95f0b9d054f994ce9ba7ef1076be6ed4f964e33a.tar.xz
kirc-95f0b9d054f994ce9ba7ef1076be6ed4f964e33a.tar.zst
kirc-95f0b9d054f994ce9ba7ef1076be6ed4f964e33a.zip
seo activities (#55)
* Update and rename README.md to README * Add files via upload * Delete example4.png * Update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md171
1 files changed, 0 insertions, 171 deletions
diff --git a/README.md b/README.md
deleted file mode 100644
index a4f6fb1..0000000
--- a/README.md
+++ /dev/null
@@ -1,171 +0,0 @@
-<!--
- Title: KISS for IRC (kirc)
- Description: A tiny IRC client written in POSIX C99.
- Author: mcpcpc
--->
-
-<h3 align="center">
- <img src="https://raw.githubusercontent.com/mcpcpc/kirc/master/.github/kirc.png" alt="kirc" 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>
- <a href="https://www.codacy.com/manual/mcpcpc/kirc/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=mcpcpc/kirc&amp;utm_campaign=Badge_Grade"><img src="https://app.codacy.com/project/badge/Grade/5616c0ed4b2f4209826038dbc270dbf5" alt="Codacy status"></a>
-</p>
-
-<p align="center">
- <img src=".github/example4.png" width="550">
-</p>
-
-## Features
-
-* Excellent cross-platform compatibility (due to POSIX standard compliance).
-* No dependencies other than a C99 compiler.
-* Native SASL PLAIN and EXTERNAL authentication support.
-* TLS/SSL protocol capable (via external TLS utilities).
-* Full chat history logging.
-* Multi-channel joining at server connection.
-* Simple command aliases and full support for all RFC 2812 commands.
-* Color scheme definition via ANSI 8-bit colors, allowing for uniform color definition across all shell applications.
-
-## Installation & Usage
-
-Building and installing on **KISS Linux** using the Community repository:
-
-```shell
-kiss b kirc
-kiss i kirc
-```
-
-Building and installing on **Arch** and **Arch-based** distros using the AUR:
-
-```shell
-git clone https://aur.archlinux.org/kirc-git.git
-cd kirc
-makepkg -si
-```
-
-Building and installing from source (works on **Raspbian**, **Debian**, **Ubuntu** and many other Unix distributions):
-
-```shell
-git clone https://github.com/mcpcpc/kirc.git
-cd kirc
-make
-make install
-```
-
-### Usage
-
-Consult `man kirc` for a full list and explanation of available `kirc` arguments.
-
-```shell
-kirc [-s hostname] [-p port] [-c channels] [-n nickname] [-r realname] [-u username] [-k password] [-a token] [-x command] [-w nick_width] [-o logfile] [-e|v|V]
-```
-
-### Command Aliases
-
-```shell
-<message> Send a PRIVMSG to the current channel.
-@<channel|nick> <message> Send a message to a specified channel or nick
-/<command> Send command to IRC server (see RFC 2812 for full list).
-/#<channel> Assign new default message channel.
-/? Print current message channel.
-```
-
-### User Input Key Bindings
-
-* **CTRL+B** or **LEFT ARROW** moves the cursor one character to the left.
-* **CTRL+F** or **RIGHT ARROW** moves the cursor one character to the right.
-* **CTRL+A** moves the cursor to the end of the line.
-* **CTRL+E** or **HOME** moves the cursor to the start of the line.
-* **CTRL+W** deletes the previous word.
-* **CTRL+U** deletes the entire line.
-* **CTRL+K** deletes the from current character to end of line.
-
-## Transport Layer Security (TLS) Support
-
-There is no native TLS/SSL support. Instead, users can achieve this functionality by using third-party utilities (e.g. stunnel, [socat](https://linux.die.net/man/1/socat), ghosttunnel, etc).
-
-* Example using `socat`. Remember to replace items enclosed with `<>`.
-
- ```shell
- socat tcp-listen:6667,reuseaddr,fork,bind=127.0.0.1 ssl:<irc-server>:6697
- kirc -s 127.0.0.1 -c 'channel' -n 'name' -r 'realname'
- ```
-
-## SASL PLAIN Authentication
-
-In order to connect using `SASL PLAIN` mechanism authentication, the user must provide the required token during the initial connection. If the authentication token is base64 encoded and, therefore, can be generated a number of ways. For example, using Python, one could use the following:
-
-```shell
-python -c 'import base64; print(base64.encodebytes(b"nick\x00nick\x00password"))'
-```
-
-For example, lets assume an authentication identity of `jilles` and password `sesame`:
-
-```shell
-$ python -c 'import base64; print(base64.encodebytes(b"jilles\x00jilles\x00sesame"))'
-b 'amlsbGVzAGppbGxlcwBzZXNhbWU=\n'
-$ kirc -n jilles -a amlsbGVzAGppbGxlcwBzZXNhbWU=
-```
-
-## SASL EXTERNAL Authentication
-
-Similar to `SASL PLAIN`, the `SASL EXTERNAL` mechanism allows us to authenticate using credentials by external means. An example where this might be required is when trying to connect to an IRC host through [Tor](https://www.torproject.org/). To do so, we can using third-party utilities (e.g. stunnel, socat, ghosttunnel, etc).
-
-* Example using `socat`. Remember to replace items enclosed with `<>`.
-
- ```shell
- socat TCP4-LISTEN:1110,fork,bind=0,reuseaddr SOCKS4A:127.0.0.1:<onion_address.onion>:<onion_port>,socksport=9050
- socat TCP4-LISTEN:1111,fork,bind=0,reuseaddr 'OPENSSL:127.0.0.1:1110,verify=0,cert=<path_to_pem>'
- kirc -e -s 127.0.0.1 -p 1111 -n <nick> -x 'wait 5000'
- ```
-
-## Color Scheme Definition
-
-Applying a new color scheme is easy! One of the quickest ways is to use an application, such as [kfc](https://github.com/mcpcpc/kfc), to apply pre-made color palettes. Alternatively, you can manually apply escape sequences to change the default terminal colors.
-
-* Example using `kfc`
-
- ```shell
- kfc -s gruvbox
- ```
-
-* Example using ANSI escape sequences
-
- ```shell
- printf -e "\033]4;<color_number>;#<hex_color_code>"
-
- # Replace <hex_color_code> with the desired Hex code (e.g. #FFFFFF is white).
- # Replace <color_number> with the one of the numbers below:
- # 0 - Regular Black
- # 1 - Regular Red
- # 2 - Regular Green
- # 3 - Regular Yellow
- # 4 - Regular Blue
- # 5 - Regular Magenta
- # 6 - Regular Cyan
- # 7 - Regular White
- # 8 - Bright Black
- # 9 - Bright Red
- # 10 - Bright Green
- # 11 - Bright Yellow
- # 12 - Bright Blue
- # 13 - Bright Magenta
- # 14 - Bright Cyan
- # 15 - Bright White
- ```
-
-## FAQ
-
-* **KISS** is an acronym for [Keep It Simple Stupid](https://en.wikipedia.org/wiki/KISS_principle), which is a design principle noted by the U.S. Navy in 1960s. The KISS principle states that most systems work best if they are kept simple rather than made complicated; therefore, simplicity should be a key goal in design, and unnecessary complexity should be avoided.
-* **POSIX** is an acronym for [Portable Operating System Interface](https://opensource.com/article/19/7/what-posix-richard-stallman-explains), which is a family of standards specified by the IEEE Computer Society for maintaining compatibility between operating systems. The *C99* Standard is preferred over other versions (e.g. *C89* or *C11*) since this currently the only one specified by [POSIX](https://pubs.opengroup.org/onlinepubs/9699919799/utilities/c99.html).
-
-## Contact
-
-For any further questions or concerns, feel free to reach out to me, [mcpcpc](https://github.com/mcpcpc), on `#kirc`
-or `#kisslinux` channels of the *irc.freenode.org* server.