-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add README with developer and user instructions
- Loading branch information
Showing
1 changed file
with
47 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,47 @@ | ||
# fonts | ||
# Omenad Fonts | ||
|
||
Font for writing Indian Classical Music. | ||
[Read the full documentation.][docs] | ||
[Download the fonts.][download] | ||
|
||
## Fonts | ||
|
||
### [Ome Swarlipi][swarlipi] | ||
|
||
[![swarlipi-image][swarlipi-image]][swarlipi] | ||
|
||
A notation system designed to be non-language specific, easy to learn, and very compact. | ||
|
||
### Bhatkhande Notation | ||
|
||
[![bhatkhande-hindi-image][bhatkhande-hindi-image]][bhatkhande-hindi] | ||
|
||
The classical system for writing Indian Classical Music. These are available for [Hindi][bhatkhande-hindi], [English][bhatkhande-english], and [Punjabi][bhatkhande-punjabi]. | ||
|
||
## Development | ||
|
||
The sources are [FontForge][fontforge] SFD files. Use it to make changes to them. | ||
|
||
Requires Docker. | ||
|
||
Use `scripts/build` to build the sources into `.ttf` files. | ||
Use `scripts/server` to run the docs. They will be accessible at http://0.0.0.0:4000/fonts/, and will watch for changes. | ||
|
||
## Releasing | ||
|
||
Uses git-flow. | ||
Ensure `CHANGELOG.md` is updated. | ||
Use `scripts/publish $TAG` to make a zip file. | ||
Make a release on GitHub. Add that zip file to it. | ||
Add a new URL to rajada.in for the release. | ||
Make a `docs/$TAG` branch and update all references for downloading it. Merge to `master`. | ||
|
||
[docs]: https://omenad.github.io/fonts/ | ||
[download]: http://rajada.in/omenadfonts210 | ||
[swarlipi]: https://omenad.github.io/fonts/ome-swarlipi/ | ||
[swarlipi-image]: https://omenad.github.io/fonts/assets/images/ome-swarlipi-thumbnail.jpg | ||
[bhatkhande-hindi]: https://omenad.github.io/fonts/ome-bhatkhande-hindi/ | ||
[bhatkhande-hindi-image]: https://omenad.github.io/fonts/assets/images/ome-bhatkhande-hindi-thumbnail.jpg | ||
[bhatkhande-english]: https://omenad.github.io/fonts/ome-bhatkhande-english/ | ||
[bhatkhande-punjabi]: https://omenad.github.io/fonts/ome-bhatkhande-punjabi/ | ||
[fontforge]: https://fontforge.org/en-US/ |