aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTill Höppner2016-02-03 03:39:35 +0100
committerTill Höppner2016-02-03 03:39:35 +0100
commit240206e4761a9447cf0bed7110061f293daa6b50 (patch)
treee2f500a4ea2808f88caefdf383e185a414ed39d6
parentcadd814c28b03205c8277530ef09bffcdba44ec6 (diff)
parent8c170746aca79d6cbc2602298c468f3fc9ededa2 (diff)
downloadilc-240206e4761a9447cf0bed7110061f293daa6b50.tar.gz
ilc-240206e4761a9447cf0bed7110061f293daa6b50.tar.xz
ilc-240206e4761a9447cf0bed7110061f293daa6b50.zip
Merge branch 'master' of github.com:tilpner/ilc
-rw-r--r--README.md28
1 files changed, 17 insertions, 11 deletions
diff --git a/README.md b/README.md
index b79b766..a95ddb7 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ ilc
[![Crates.io version](https://img.shields.io/crates/v/ilc.svg?style=flat-square)](https://crates.io/crates/ilc)
[![Crates.io license](https://img.shields.io/crates/l/ilc.svg?style=flat-square)](https://crates.io/crates/ilc)
-**What is this thing?**
+#### What is this thing?
ilc is a library to work with common IRC log formats, as well as a collection
of commonly needed utilities for IRC logs.
@@ -12,24 +12,30 @@ of commonly needed utilities for IRC logs.
The library can convert between most of the EnergyMech (ZNC) and Weechat3 log formats, as well as binary and msgpack representations of them.
The tools can merge, convert, and pretty-print them, or count the lines/words that people said in them.
-**Fine, I'll try it. Do I really have to compile it myself?**
+#### Fine, I'll try it. Do I really have to compile it myself?
-Probably. I sporadically [release a binary](https://github.com/tilpner/ilc/releases), but those are for x86-64 Linux. If you want something else, or more recent, you'll have to compile yourself.
+Probably. I sporadically [release a binary](https://github.com/tilpner/ilc/releases), but those are for x86_64 Linux. If you want something else, or more recent, you'll have to compile yourself.
-**Okay, how do I compile it then?**
+#### Okay, how do I compile it then?
-Because I'm using experimental features (slice_patterns), you have to use a Rust nightly installation.
+Because I'm using experimental features (slice_patterns), you have to use a Rust nightly installation either way.
+
+###### From crates.io
+
+ cargo install ilc
+
+###### From git
`67ee599c56ba9e58cfe190036b7dcc656b20bfdd` is known to compile with
- rustc 1.8.0-nightly (d63b8e539 2016-01-23)
- cargo 0.8.0-nightly (8edc460 2016-01-21)
+> rustc 1.8.0-nightly (d63b8e539 2016-01-23)
+> cargo 0.8.0-nightly (8edc460 2016-01-21)
To compile:
cargo build --release
-**Usage**
+#### Usage
```
Usage:
ilc parse [options] [-i FILE...]
@@ -53,16 +59,16 @@ Options:
--infer-date Try to use the filename as date for the log.
```
-**Are you stupid? Why Rust?**
+#### Are you stupid? Why Rust?
Uhh, actually... that may have been a suboptimal choice. Nobody cares about performance here
anyways. But it was what I started with, and I didn't feel like rewriting it.
-**I found a bug!**
+#### I found a bug!
Great! Or... well, not so great. Please file it [here](https://github.com/tilpner/ilc/issues/new)!
-**It doesn't support my format.**
+#### It doesn't support my format.
Support for irssi is planned, but beyond that you'll have to file an issue or implement it yourself.
PRs are welcome, but I can't promise to merge all of them without revision. :)