voronind/resume
1
0
Fork 0
Code Issues 2 Pull requests Packages Projects Releases 2 Wiki Activity

Readme : Add info about Nix shell support & cleanup.

Browse source
This commit is contained in:
Dmitry Voronin 2024-02-09 03:57:14 +03:00
parent 2d2ae44216
commit 9d0b655e72
1 changed files with 10 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
Readme.md
View file

@ -7,11 +7,13 @@
[Русская версия](/voronind/resume/releases/download/latest/voronind_ru.pdf) [Русская версия](/voronind/resume/releases/download/latest/voronind_ru.pdf)
## How to build. ## How to build.
```bash ```bash
$ make $ make
``` ```
### Available targets. ### Available targets.
Taget | Description Taget | Description
--- | --- --- | ---
all | Clean, build and open all languages. all | Clean, build and open all languages.
@ -21,25 +23,19 @@ en | Build English resume.
ru | Build Russian resume. ru | Build Russian resume.
open | Open built resumes in default PDF viewer. open | Open built resumes in default PDF viewer.
### Nix shell support.
```bash
nix develop
```
## Requirements. ## Requirements.
* `GNU/Linux` (not tested on other platforms). * `GNU/Linux` (not tested on other platforms).
* `LuaLaTeX` for the document itself. * `LuaLaTeX` for the document itself.
* `ImageMagick` (optional) for colored icons. * `ImageMagick` (optional) for colored icons.
### Texlive setup.
```text
$ wget https://mirror.ctan.org/systems/texlive/tlnet/install-tl-unx.tar.gz
$ tar -xf install-tl-unx.tar.gz
$ rm install-tl-unx.tar.gz
$ cd ./install-tl-*
$ ./install-tl
```
### Installing missing dependencies. ### Installing missing dependencies.
When trying to build the project, lualatex may throw missing dependency errors. When trying to build the project, lualatex may throw missing dependency errors.
To install them use `$ tlmgr install $dependency`. To install them use `$ tlmgr install $dependency`.
## TODO.
- [x] Change icon color on build.
- [x] Fallback for using black icons if ImageMagick is not available.
- [ ] Show warning if ImageMagick is not available.