aniani/irssi
1
0
Fork 0
mirror of https://github.com/irssi/irssi.git synced 2024-06-16 06:25:24 +00:00
Code

Cleanup README.md

Browse Source 
This patch restructures and cleans up README.md slightly to make it a
more structured for Github's README.md repository view.
This commit is contained in:
Alexander Færøy 2014-06-12 12:15:31 +02:00
parent 8be1e1001a
commit 1d45fdfa03
1 changed files with 19 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -1,28 +1,15 @@
# irssi, http://irssi.org
# Irssi
Irssi is a modular IRC client that currently has only text mode user interface,
but 80-90% of the code isn't text mode specific, so other UIs could be created
pretty easily. Also, Irssi isn't really even IRC specific anymore, there's
already a working [SILC](http://www.silcnet.org/) module available. Support for
other protocols like ICQ could be created some day too.
## Installation
See the `INSTALL` file.
## Files
- The `docs/` directory contains several documents:
- `startup-HOWTO.txt` - new users should read this
- `manual.txt` - manual I started writing but didn't get it very far :)
- `perl.txt` - Perl scripting help
- `formats.txt` - How to use colors, etc. with irssi
- `faq.txt` - Frequently Asked Questions
- `special_vars.txt` - some predefined $variables you can use with irssi
## About
Irssi is a modular IRC client that currently has only text mode user
interface, but 80-90% of the code isn't text mode specific, so other
UIs could be created pretty easily. Also, Irssi isn't really even IRC
specific anymore, there's already a working SILC (http://www.silcnet.org)
module available. Support for other protocols like ICQ could be created
some day too.
## Features
So what's so great about Irssi? Here's a list of some features I can
@ -96,10 +83,20 @@ think of currently:
said your name (as seen in awaylog) or topic was changed (/last
-topics)
## Files
- The `docs/` directory contains several documents:
- `startup-HOWTO.txt` - new users should read this
- `manual.txt` - manual I started writing but didn't get it very far :)
- `perl.txt` - Perl scripting help
- `formats.txt` - How to use colors, etc. with irssi
- `faq.txt` - Frequently Asked Questions
- `special_vars.txt` - some predefined $variables you can use with irssi
## Bugs / Suggestions
See the `TODO` file, http://bugs.irssi.org and the GitHub issues if it is
already listed in there; if not, open an issue on GitHub or [send a mail to
staff@irssi.org](mailto:staff@irssi.org)
already listed in there; if not, open an issue on GitHub or send a mail to
[staff@irssi.org](mailto:staff@irssi.org).
You can also contact the Irssi developers in #irssi on freenode.