Readme

2017-09-22 15:32:00 +02:00
parent 0a9cf189a0
commit 0f9a8097bb
2 changed files with 26 additions and 0 deletions
@@ -0,0 +1,26 @@
 # kifugen
 Generate printable pdf game records (kifu) from `sgf` go/baduk/weiqi replays.
 kifugen takes your `sgf` file and converts is into a `latex` format, that then can
 be easily compiled into a pdf file.
 ![Preview Image](pdfpreview.png)
 # Requirements
 To run kifugen you will need:
 - Python 3.6
 - A latex distribution with:
    - `latex`
    - `dvips`
    - `ps2pdf`
    - the `psgo` package
 # Usage
 The basic usage is `kifugen <file> [options]` where file is the `.sgf` file and options are:
 | Option         | Meaning                       |
 | :------------- | :---------------------------- |
 | -se n          | "split every" n moves         |
 | -c             | compile to pdf                |
 | -o             | open the pdf after compilation|