aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorla-ninpre <leobrekalini@gmail.com>2020-11-18 11:13:28 +0300
committerla-ninpre <leobrekalini@gmail.com>2020-11-18 11:16:16 +0300
commit061af291ff6117ff015f9192855bd00b19fd9ea8 (patch)
treeb73b82850365e16e22cc018f0f99966e1e2c105b /README.md
parent3085cb9d40abeb4d25299b86145e007cd9fac712 (diff)
downloadPutnik-061af291ff6117ff015f9192855bd00b19fd9ea8.tar.gz
Putnik-061af291ff6117ff015f9192855bd00b19fd9ea8.zip
add requirements.txt and simplify build
now everything is happening inside vitrual environment, which is much more safe and easier to use.
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 23 insertions, 9 deletions
diff --git a/README.md b/README.md
index b5afaa9..39d42c1 100644
--- a/README.md
+++ b/README.md
@@ -2,49 +2,63 @@
![Font Preview](docs/preview.png)
-Putnik is rough condensed cyrillic display font. It is primarily inspired by runic script, early cyrillic script and wooden pagan inscriptions.
+Putnik is rough condensed cyrillic display font. It is primarily inspired by
+runic script, early cyrillic script and wooden pagan inscriptions.
This font is non-professional, though.
-Putnik was made especially for [short-movie by Ilya Osenev](https://www.youtube.com/watch?v=VteH0cZsxPg) with the same name.
+Putnik was made especially for
+[short-movie by Ilya Osenev](https://www.youtube.com/watch?v=VteH0cZsxPg) with
+the same name.
Font is made with Inkscape and FontForge.
## Glyph set
-Currently there's not too much glyphs. There is cyrillic (all caps), digits and incomplete set of punctuation.
+Currently there's not too much glyphs. There is cyrillic (all caps), digits and
+incomplete set of punctuation.
## Compilation
### Prerequisites
-You need python, pip and fontmake.
+All you need is python and pip and venv modules. If you are using Linux or MacOS,
+chanses are you already have all of this. If not, install them using your package
+manager.
-```terminal
-$ python -m pip install fontmake
+```console
+$ which python
+/usr/bin/python
+$ python -m pip --version
+pip XX.X.X from /usr/lib/python3.8/site-packages/pip (python 3.8)
```
### Building
To build both otf and ttf versions, just run
-```terminal
+```console
$ make
```
+This will create python virtual environment in directory `venv`, install fontmake
+package from requirements.txt and build the fonts to `fonts/` directory.
+
If you want only ttf or otf, run
-```terminal
+```console
$ make otf
```
or
-```terminal
+```console
$ make ttf
```
respectively.
+To make zip or tarball package, run `make release`.
+
## Todo's
- all punctuation