X-Git-Url: https://software.frrobert.com/proportionaltomonofont/blobdiff_plain/9a96d04cdd2919964169192e7d9de5012ef66de4..HEAD:/README.md
diff --git a/README.md b/README.md
index 88155ac..3fdc32e 100644
--- a/README.md
+++ b/README.md
@@ -1,47 +1,65 @@
-# Comic Mono
-A legible monospace font... the very typeface youâve been trained to recognize since childhood. This font is a fork of [Shannon Miwa](https://github.com/shannpersand)âs [Comic Shanns](https://github.com/shannpersand/comic-shanns) (version 1).
-
-
-
-## Download
-- [ComicMono.ttf](https://dtinth.github.io/comic-mono-font/ComicMono.ttf)
-- [ComicMono-Bold.ttf](https://dtinth.github.io/comic-mono-font/ComicMono-Bold.ttf)
-
-## Differences from Comic Shanns
-1. All glyphs have been [adjusted](https://www.reddit.com/r/programming/comments/kj0prs/comic_mono_font/ghc7krt/?utm_source=reddit&utm_medium=web2x&context=3) to have exactly the same width (using code based on [monospacifier](https://github.com/cpitclaudel/monospacifier)).
-2. The glyph metrics have been adjusted to make it display better alongside system font, based on [Cousine](https://fonts.google.com/specimen/Cousine)âs metrics.
-3. The name is changed to `Comic Mono`.
-4. A bold version of the font is generated using [FontForgeâs Embolden](https://fontforge.github.io/Styles.html#Embolden) operation.
-
-I have no font creation skills; Iâm just a software developer. This font family is created by patching the original font, [Comic Shanns (v1)](https://github.com/shannpersand/comic-shanns), using a Python script, [`generate.py`](generate.py).
-
-## What does it look like?
-
-
-```python
-{% include_relative generate.py %}
-```
-
-## CDN
-You can use this font in your web pages by including the stylesheet. CDN is provided by [jsDelivr](https://www.jsdelivr.com/package/npm/comic-mono).
-```html
-
-```
-
-## npm Package
-The contents of this package is also [published to npm](https://www.npmjs.com/package/comic-mono), although the font files are not optimized. See fontsource package (below) for a better option.
-
-## Packages published by third parties
-- Fontsource: [@fontsource/comic-mono](https://www.npmjs.com/package/@fontsource/comic-mono) ([thanks @DecliningLotus](https://github.com/fontsource/fontsource/pull/117))
-- Arch Linux AUR: [ttf-comic-mono-git](https://aur.archlinux.org/packages/ttf-comic-mono-git/) (maintained by DBourgeoisat)
+# This project is a fork of dtinth/comic-mono-font
+
+That project was to create a font. This project is designed to use the generate.py script and use it to take a proportional spaced font and make it a mono spaced font.
+
+This may be a very silly idea. I have got the script to work to generate a mono spaced font from a proportional font. The key is tweaking the height and width so the fonts look nice.
+
+## Dependencies
+
+Python 2
+
+The python bindings for font forge
+
+This link may help you install the bindings
+
+[https://stackoverflow.com/questions/36508944/install-fontcustom-fontforge-in-ubuntu](https://stackoverflow.com/questions/36508944/install-fontcustom-fontforge-in-ubuntu)
+
+## How to use the script
+
+Install the Dependencies
+Put the proportional font you are going to convert in the vendor directory
+Put the reference font you are going to use in the vendor directory
+Edit the script. See bellow
+Make the script executable
+Run ./generate.py
+Your normal font and bold font will be generated and should be found in the same directory as generate.py
+The fonts can now be installed.
+Depending on the width and height you set will affect what the font actually looks like. It could look nice or it could look awful.
+
+## You need to edit the script. Here is the list of things you need to change:
+
+### Change the following two lines to the script to the font you are going to convert and the reference font
+font = fontforge.open('vendor/comic-shanns.otf')
+ref = fontforge.open('vendor/Cousine-Regular.ttf')
+
+### Change the integer value the larger the number the wider the font
+target_width = 510
+
+#### change number in adjust_height to make font shorter or taller
+adjust_height(font, ref, 0.875)
+
+### change to desired font name
+font.fontname = 'ComicMono'
+### change to desired full name
+font.fullname = 'Comic Mono'
+#change to desired file name
+font.generate('ComicMono.ttf')
+
+### Bold section
+### change to desired font name
+font.fontname = 'ComicMono-Bold'
+
+### change to desired full name
+font.fullname = 'Comic Mono Bold'
+
+### change to desired file name
+font.generate('ComicMono-Bold.ttf')
+
+## Notes:
+What is the reference font for?
+Taken from Comic Mono font README.md
+The glyph metrics have been adjusted to make it display better alongside system font, based on Cousineâs metrics.
+You could use a different font as the reference as see how it changes the font.
## License
It is licensed under the [MIT License](LICENSE).