Skip to content

Commit

Permalink
released at 0.3.2 (#130)
Browse files Browse the repository at this point in the history
Co-authored-by: Michael Czigler <contact@mcpcpc.com>
  • Loading branch information
mcpcpc and Michael Czigler authored Jan 5, 2023
1 parent 851eed5 commit 3bb2b8d
Show file tree
Hide file tree
Showing 9 changed files with 1,146 additions and 1,016 deletions.
10 changes: 0 additions & 10 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,2 @@
# These are supported funding model platforms

github: mcpcpc
patreon: # Replace with a single Patreon username
open_collective: # Replace with a single Open Collective username
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
custom: https://www.paypal.me/mcpcpc/usd5
8 changes: 1 addition & 7 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
kirc
*.a
*.o
*.txt
tags
*.out
*.log
*.diff
.*.swp
*.o
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2021-2022 Michael Czigler
Copyright (c) 2021-2023 Michael Czigler

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
6 changes: 2 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
.POSIX:
ALL_WARNING = -Wall -Wextra -pedantic
ALL_LDFLAGS = $(LDFLAGS)
ALL_CFLAGS = $(CPPFLAGS) $(CFLAGS) -std=c99 $(ALL_WARNING)
PREFIX = /usr/local
LDLIBS = -lm
BINDIR = $(PREFIX)/bin
MANDIR = $(PREFIX)/share/man

all: kirc
all: clean kirc
install: all
mkdir -p $(DESTDIR)$(BINDIR)
mkdir -p $(DESTDIR)$(MANDIR)/man1
Expand All @@ -17,8 +16,7 @@ install: all
chmod 644 $(DESTDIR)$(MANDIR)/man1/kirc.1
kirc: kirc.o
$(CC) $(ALL_LDFLAGS) -o kirc kirc.o $(LDLIBS)
kirc.o: kirc.c
$(CC) $(ALL_CFLAGS) -c kirc.c
kirc.o: kirc.c kirc.h
clean:
rm -f kirc *.o
uninstall:
Expand Down
64 changes: 0 additions & 64 deletions README

This file was deleted.

55 changes: 55 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# kirc

kirc (KISS for IRC) is a tiny IRC client written in POSIX C99.

## Installation

Building and installing from source:

git clone https://github.com/mcpcpc/kirc
cd kirc
make
make install

## Usage

Consult `man kirc` for a full list and explanation of available arguments.

kirc [-s hostname] [-p port] [-c channels] [-n nickname] [-r realname]
[-u username] [-k password] [-a token] [-o logfile] [-e|x|v|V]

## Command Aliases

<message> send PRIVMSG to the current channel.
@<channel|nick> <message> send PRIVMSG to a specified channel or nick.
@@<channel|nick> <message> send CTCP ACTION message to a specified channel
or nick (if no channel or nick is specified, the
message will be sent to the default channel).
/<command> send command to the IRC server (see RFC 2812).
/#<channel> assign new default message channel.

## Key Bindings

CTRL+B or LEFT ARROW move the cursor one character to the left.
CTRL+F or RIGHT ARROW move the cursor one character to the right.
CTRL+P or UP ARROW move to previous record in the input history buffer.
CTRL+N or DOWN ARROW move to next record in the input history buffer.
CTRL+E move the cursor to the end of the line.
CTRL+A or HOME move the cursor to the start of the line.
CTRL+W delete the previous word.
CTRL+U delete the entire line.
CTRL+K delete the from current character to end of line.
CTRL+D delete the character to the right of cursor.
CTRL+C force quit kirc.
CTRL+T swap character at cursor with previous character.
CTRL+H equivalent to backspace.

## Support Documentation

Please refer to the [official homepage](http://kirc.io/docs.html) for examples,
troubleshooting and use cases.

## Contact

For any further questions or concerns, feel free to send me an
[email](michaelczigler[at]mcpcpc[dot]com).
3 changes: 2 additions & 1 deletion kirc.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.TH KIRC 1 kirc\-VERSION
.\"Manpage for kirc.
.TH KIRC 1 "NOVEMBER 2020" Linux "User Manuals"
.SH NAME
kirc \- KISS for IRC
.SH SYNOPSIS
Expand Down
Loading

0 comments on commit 3bb2b8d

Please sign in to comment.