REVEEEEERT!
[gofetch.git] / README.md
CommitLineData
73785268
NR
1# GoFetch
2
3GoFetch is a simple web scrapper that outputs gopher-ready files.
4You point it to your gopher directory, you launch it, and you have a
5gopher view of the supported news sites.
6
7## Supported websites
8
9- Slashdot: News for nerds, stuff that matters!
10
11## Supported platforms
12
13Any platform with at lest Java 1.6 on it should be ok.
14
15## Usage
16
17```java -jar gofetch.jar [dir] [selector] [type] [max] [hostname] [port]```
18
19- dir: the target directory where to store the files
20- selector: the gopher selector to prepend (also a sub-directory in [dir])
21- max: the maximum number of stories to show on the main page
22- hostname: the gopher hostname
23- port: the gopher port
24
25## Compilation
26
27```./configure.sh && make```
28
29You can also import the java sources into, say, [Eclipse](https://eclipse.org/), and create a runnable JAR file from there.
30
31### Dependant libraries (included)
32
33- libs/nikiroo-utils-sources.jar: some shared utility functions I also use elsewhere
34- [libs/jsoup-sources.jar](https://jsoup.org/): a nice library to parse HTML
35
36Nothing else but Java 1.6+.
37
38Note that calling ```make libs``` will export the libraries into the src/ directory.
39