diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..4823dfc --- /dev/null +++ b/Readme.md @@ -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 [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| diff --git a/pdfpreview.png b/pdfpreview.png new file mode 100644 index 0000000..8bff99b Binary files /dev/null and b/pdfpreview.png differ