diff --git a/docs/.gitbook/assets/caret-position (1).gif b/docs/.gitbook/assets/caret-position (1).gif new file mode 100644 index 0000000..60b9964 Binary files /dev/null and b/docs/.gitbook/assets/caret-position (1).gif differ diff --git a/docs/.gitbook/assets/caret-position.gif b/docs/.gitbook/assets/caret-position.gif new file mode 100644 index 0000000..60b9964 Binary files /dev/null and b/docs/.gitbook/assets/caret-position.gif differ diff --git a/docs/.gitbook/assets/new-ligatures (1).png b/docs/.gitbook/assets/new-ligatures (1).png new file mode 100644 index 0000000..0cc32b3 Binary files /dev/null and b/docs/.gitbook/assets/new-ligatures (1).png differ diff --git a/docs/.gitbook/assets/new-ligatures.png b/docs/.gitbook/assets/new-ligatures.png new file mode 100644 index 0000000..0cc32b3 Binary files /dev/null and b/docs/.gitbook/assets/new-ligatures.png differ diff --git a/docs/.gitbook/assets/operator-mono-lig (1).png b/docs/.gitbook/assets/operator-mono-lig (1).png new file mode 100644 index 0000000..6d13bb2 Binary files /dev/null and b/docs/.gitbook/assets/operator-mono-lig (1).png differ diff --git a/docs/.gitbook/assets/operator-mono-lig.png b/docs/.gitbook/assets/operator-mono-lig.png new file mode 100644 index 0000000..6d13bb2 Binary files /dev/null and b/docs/.gitbook/assets/operator-mono-lig.png differ diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index bb7bfd6..7024ef8 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -2,3 +2,9 @@ * [Introduction](README.md) +## Developing ligatures + +* [Setting up your development environment](developing-ligatures/setting-up-your-development-environment.md) +* [Designing your first ligature](developing-ligatures/designing-your-first-ligature.md) +* [Committing your Glyphs file](developing-ligatures/committing-your-glyphs-file.md) + diff --git a/docs/developing-ligatures/committing-your-glyphs-file.md b/docs/developing-ligatures/committing-your-glyphs-file.md new file mode 100644 index 0000000..8015be9 --- /dev/null +++ b/docs/developing-ligatures/committing-your-glyphs-file.md @@ -0,0 +1,21 @@ +# Committing your Glyphs file + +The Glyphs file is very difficult to merge, so standard tools like `git rebase` don't work well. I have created some tools that will allow you to update your existing Glyphs file on top of the current. + +{% hint style="warning" %} +Make sure you have created a separate branch for your changes and you've committed all your changes to the branch. +{% endhint %} + +1. When you're ready to issue a PR for your changes, you need to run the `./tools/glyphysrebase.sh` tool. +2. You can now create your PR, or continue making changes and running the rebase tool periodically to keep up-to-date with master. + +## How the tool works + +1. Checks out a clean copy of `master` in a temporary folder. +2. Copies your current working copy to a backup folder. +3. Copies the master copy into your working copy \(basically resetting everything back before your changes\). +4. Runs the `./tools/copyallglyphs.sh` script to copy ligatures from your backup folder to the current master in your working copy. +5. At this point, you now have a glyphs file that includes your custom ligatures on top of the current master. +6. The "rebased" files are then committed. +7. You can now issue a PR. This should easily merge into master. + diff --git a/docs/developing-ligatures/designing-your-first-ligature.md b/docs/developing-ligatures/designing-your-first-ligature.md new file mode 100644 index 0000000..e2df5eb --- /dev/null +++ b/docs/developing-ligatures/designing-your-first-ligature.md @@ -0,0 +1,23 @@ +# Designing your first ligature + +## Getting Super Powers + +Becoming a super hero is a fairly straight forward process: + +``` +$ give me super-powers +``` + +{% hint style="info" %} + Super-powers are granted randomly so please submit an issue if you're not happy with yours. +{% endhint %} + +Once you're strong enough, save the world: + +``` +// Ain't no code for that yet, sorry +echo 'You got to trust me on this, I saved the world' +``` + + + diff --git a/docs/developing-ligatures/setting-up-your-development-environment.md b/docs/developing-ligatures/setting-up-your-development-environment.md new file mode 100644 index 0000000..f4f8539 --- /dev/null +++ b/docs/developing-ligatures/setting-up-your-development-environment.md @@ -0,0 +1,23 @@ +# Setting up your development environment + +## Getting Super Powers + +Becoming a super hero is a fairly straight forward process: + +``` +$ give me super-powers +``` + +{% hint style="info" %} + Super-powers are granted randomly so please submit an issue if you're not happy with yours. +{% endhint %} + +Once you're strong enough, save the world: + +``` +// Ain't no code for that yet, sorry +echo 'You got to trust me on this, I saved the world' +``` + + +