Update README.md

This commit is contained in:
Abbie Gonzalez 2019-10-07 20:21:10 -04:00 committed by GitHub
parent d383926feb
commit a5a664ea69
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,76 +1,68 @@
# ReadMe # ReadMe
This is an effort to recreate Open-Dyslexic with the SIL-OFL typeface. This is OpenDyslexic, recreated in SIL-OFL. antijingoist/opendyslexic will be the official OpenDyslexic repo.
## Why? ## Why?
The Bitstream license was too restrictive, and my attempts at clarifying what was allowed (pretty much anything) just confused everything even more. I should have also done it from the start. Also, restarting it allows me to implement it more consistently, with reusable components and give it additional scrutiny. The Bitstream license was too restrictive, and my attempts at clarifying what was allowed (pretty much anything) just confused everything even more. I should have also done it from the start.
It is a typeface that uses various methods to help with some symptoms of dyslexia (as defined by the DSM-V). Goals were to make reading comfortable, with visual cues to help with blinding on white pages, confusing similar letters, and not being able to keep your place among others. By keeping it free and opensource, it would be easier to have studies done, and information from those studies and users can in turn help the typeface continue to improve. Also.... <sub>easier to correct some mistakes when starting from scratch.</sub>
In short: ## Styles
* Bolder letters, even bolder punctuation. OpenDyslexic, in Regular, Bold, Italic, and BoldItalic. Also, OpenDyslexic Mono, and OpenDyslexic Rounded: intentionally lower contrast.
* Letter are heavier at their bottom. Like underlining the 9 on an Uno card.
* uniquely shaped characters to make confusing them more difficult.
* Extended ascenders on lowercase letters to help with recognition.
* wider horizontal spacing and more spacing between lines.
## Downloads ## Features?
Releases are listed here: https://github.com/antijingoist/opendyslexic/releases * Not Comic Sans (J/K I like Comic Sans)
These releases contain the font files in OTF and WOFF, and a PDF of the full list of characters. There are no exe's, and no installers in these packages. * OpenDyslexic aims to use unique letter shapes to make recognizing text easier.
* Longer ascenders and descenders to better distinguish caps, lowercase, and similar lowercase letters.
* Bolder bottoms of letters to communicate orientation, and better help differentiate between letters like pqdb. Similar to having an underlined _6_ so the similar looking 6 and 9 can be told apart in a game.
* Bolder punctuation shows more clearly.
* Wider spacing for easier tracking.
* Lower contrast design to help with glare/blindness: the occasional blank paper with text on it.
* Larger space between lines.
Releases are $0. You can donate using the sponsors button above or from opendyslexic.org If you donate from the Patreon, you'll get access to some goodies: an OpenDyslexic screensaver, software and a zip file of the studies I am aware of up to this point. OpenDyslexic now also includes:
* Color symbols and punctuation
* More characters. I tried to include it all.
## Submissions ## Submissions
Open-Dyslexic submissions were messy because they mostly came in compiled typeface files, creating a lot of work in comparing files, properly pulling them from the compiled typeface and moving them over to the app native source being used. Open-Dyslexic submissions were messy because they mostly came in compiled typeface files, creating a lot of work in comparing files, properly pulling them from the compiled typeface and moving them over to the app native source being used.
As such, submissions are accepted as long as: As such, submissions are accepted as long as:
* it's provided as a pull request against the typeface source
* it's provided as a pull request against the typeface source
* it's submitted as an SVG document * it's submitted as an SVG document
## Contributions also include contributions from antijingoist/open-dyslexic
They are listed here: https://github.com/antijingoist/open-dyslexic/graphs/contributors
## Additional Significant Contributers
The following people contributed to the project existing.
* My wife
* Cheryl Marshall
* Eric Bailey
* Steven V James
* @Nguarracino
* Plow Software
Includes contributions from Rob Carpenter (the rounded a), Charade-Estel (help with accents, longer ascenders and descenders, and Robert Gabriel for continued work on the Chrome extension.
## Allowed uses: ## Allowed uses:
_see OFL-FAQ.txt_ _see OFL-FAQ.txt_
## Re-hosting ## Re-hosting
K.I.S.S. If you put it on a CDN to share, let me know, and I can include links here. KISS. If you put it on a CDN to share, let me know, and I can include links.
## Sharing Products making use of OpenDyslexic ## Sharing Products
I'll work on a submission process for this. E-mail wasn't the best place to receive these, but until then, you can email. I'll work on a submission process for this. E-mail wasn't the best place to receive these. In the meantime.... support.abbiecod.es
## Studies
I'll have a proper release of these, but in the meantime, its in the patreon rewards. Or you could search google for opendyslexic filetype:pdf, (!pdf opendyslexic on duckduckgo). Remember to count the number of participants and check the version number.
## Attribution ## Attribution
_the OFL-FAQ.txt document is fantastic at frequently asked questions, and it contains information about this also. :)_ _the OFL-FAQ.txt document is fantastic at frequently asked questions, and it contains information about this also. :)_
If you _need_ my *preferred* attribution method: If you _need_ my *preferred* attribution method:
* Include name, typeface name and URL so others know where to find it.. * Include name, typeface name and URL so others know where to find it.
♡ Copying is an act of love. Please copy. ## Privacy policy
Typefaces don't gather any information, so no need to worry about that.
Everything from downloads to websites are provided by the service.
## Filling out school/business forms
If you need a form for your school or business, create a support request (support.abbiecod.es) and please be patient. 🤞🏼 You can speed up turn around time by asking for the information you need for the form separately, or pre-filling the parts you know.
Some of these forms are upwards of 20 pages of information that needs to be filled out yearly.