Add LICENSE and README files.
[dead/lwn-epub.git] / doc / README
1 1. What is it?
2
3 A utility to convert LWN (http://lwn.net/) articles into EPUB format.
4
5 Every week I read the LWN, and it's a little nicer if I can use an
6 ebook reader. But, the LWN markup isn't all that great, and I wanted
7 to learn HXT. So lwn-epub downloads the article (or issue), cleans it
8 up, and writes it to EPUB with a stylesheet that looks decent on the
9 Kindle.
10
11
12 2. Requirements
13
14 All of the software dependencies are listed in the lwn-epub.cabal
15 file.
16
17 An LWN account is not necessary. If you have one, you'll be able to
18 grab the current issue. If not, you'll be limited to what visitors to
19 the site can see.
20
21
22 3. Installation
23
24 Cabal handles the build, so do whatever you normally do to install
25 cabal packages. If you just want to install it for your user,
26
27 make install
28
29 should do it.
30
31
32 4. Usage
33
34 If you have an LWN account, you can use it. Simply set,
35
36 username = foo
37 password = bar
38
39 in ~/.lwn-epub/lwn-epub.conf, and it will be used.
40
41 To download an article or issue, just call lwn-epub with its name or
42 number as an argument. The program will try to be smart about this and
43 figure out what you mean. For example, to download the current issue
44 as "current.epub", you would run,
45
46 lwn-epub -o current.epub current/bigpage
47
48 Watch out: without the -o flag, it will output to stdout.
49
50
51 5. How to report bugs
52
53 Email them to me at michael@orlitzky.com.