Skip to content

Commit cd5b503

Browse files
committed
Enhance README (suggested changes).
Add explict build deps (latex USE flag on sphinx) for those running Gentoo.
1 parent 6999a0d commit cd5b503

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Vim for humans
22

3-
## Installation
3+
## Install
44

55
Be sure to create a symlink named 'vim-for-humans' in the project directory. This symlink should point to a directory where you've cloned [code examples](https://github.com/vjousse/vim-for-humans).
66

@@ -11,6 +11,17 @@ You will need some prerequisites to be able to compile the LaTeX source code:
1111
- [Sphinx](http://sphinx-doc.org/) to generate the epub file.
1212
- [kindlegen](http://www.amazon.com/gp/feature.html?docId=1000765211) to generate the .mobi file.
1313

14-
## Compiling
14+
### Gentoo
1515

16-
If you've installed everything, running the `makedist.sh` script should do the trick. If not, be sure to check the content of the script and to run each command one after another.
16+
* dev-python/sphinx[latex]
17+
* dev-python/pygments
18+
* app-text/texlive
19+
* kindlegen package not available.
20+
21+
## Compile
22+
23+
After the dependencies have been installed, create the dist directory via `mkdir dist` then run `makedist.sh` script to start compiling. The compilation fails be sure to check the content of the script and try running each command one after another.
24+
25+
## Enjoy
26+
27+
Upon success outputs can be found in the `dist/vimpourleshumains/` directory. Enjoy!

0 commit comments

Comments
 (0)