summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/fonts/amiri/README
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/fonts/amiri/README')
-rw-r--r--Master/texmf-dist/doc/fonts/amiri/README61
1 files changed, 61 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/fonts/amiri/README b/Master/texmf-dist/doc/fonts/amiri/README
index c8fbceed9d5..ed2c3595b2b 100644
--- a/Master/texmf-dist/doc/fonts/amiri/README
+++ b/Master/texmf-dist/doc/fonts/amiri/README
@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/alif-type/amiri.svg?branch=master)](https://travis-ci.org/alif-type/amiri)
+
Amiri Font
==========
@@ -26,5 +28,64 @@ Latest version of the Amiri font can be optained from its web site:
> http://amirifont.org
+Contributing
+------------
+
+To edit the font sources, you will need FontForge, preferably the latest
+version. To install FontForge on Debian and Ubuntu:
+
+ $ sudo apt-get install fontforge
+
+You can then open the source files in FontForge and start editing, either from
+GUI or from the command line:
+
+ $ fontforge sources/Amiri-Regular.sfdir
+
+To build the fonts you need FontForge Python module, gpp and FontTools:
+
+ $ sudo apt-get install python-fontforge gpp
+ $ python -m venv amiri --system-site-packages
+ $ . amiri/bin/activate
+ $ pip install fonttools brotli
+
+To build the font files run:
+
+ $ make ttf
+
+To build the font files along with the web files; run:
+
+ $ make web
+
+Ubuntu 16.04 Contributors
+-------------------------
+
+You might face an error with importing fontforge
+
+ File "tools/build.py", line 18, in <module>
+ import fontforge
+ ImportError: No module named fontforge
+
+This is because fontforge does not work properly with Python 3 on Ubuntu 16.04.
+To build the fonts with Python version 2.7 ; install FontForge Python
+module by following the instructions from the [official documentation][3]. But
+make sure to enable python extension and scripting for Python 2. Use the following
+commands instead of the original in the last step of the installation:
+
+ $ cd fontforge
+ $ ./bootstrap
+ $ ./configure --enable-python-extension --enable-python-scripting=2
+ $ make
+ $ sudo make install
+ $ sudo ldconfig
+
+After that, return back to the directory of the amiri repository and continue
+with python-fontforge, gpp, and the virtual environment
+
+ $ sudo apt-get install python-fontforge gpp
+ $ virtualenv amiri --system-site-packages
+ $ . amiri/bin/activate
+ $ pip install fonttools brotli
+
[1]: http://www.bibalex.org/bulaqpress/en/bulaq.htm "The Bulaq Press"
[2]: http://scripts.sil.org/OFL "The Open Font License"
+[3]: https://github.com/fontforge/fontforge/blob/master/INSTALL-git.md "FontForge official documentation" \ No newline at end of file