Skip to content

Commit 5f7722b

Browse files
committed
Merge pull request #53 from statico/readme
README improvements for people like me who can't read
2 parents 2e340b8 + d85423f commit 5f7722b

File tree

1 file changed

+21
-27
lines changed

1 file changed

+21
-27
lines changed

README.md

Lines changed: 21 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,52 @@
1-
Source Code Pro
2-
====
1+
# Source Code Pro
32

4-
Overview
5-
----
63
Source Code Pro is a set of OpenType fonts that have been designed to work well
74
in user interface (UI) environments. In addition to a functional OpenType font, this open
85
source project provides all of the source files that were used to build this OpenType font
96
by using the AFDKO makeotf tool.
107

11-
Getting Involved
12-
----
13-
Send suggestions for changes to the Source Code OpenType font project maintainer,
14-
[email protected], for consideration.
8+
## Download font binaries (OTF and TTF files)
159

10+
The font binaries are not part of the repository. They can be
11+
[downloaded from SourceForge here](https://sourceforge.net/projects/sourcecodepro.adobe/files/).
1612

17-
Font Binaries (OTF and TTF files)
18-
====
19-
The font binaries are not part of the repository. They can be downloaded from [SourceForge](https://sourceforge.net/projects/sourcecodepro.adobe/files/).
13+
## Installation instructions
2014

15+
* [Mac OS X](http://support.apple.com/kb/HT2509)
16+
* [Windows](http://windows.microsoft.com/en-us/windows-vista/install-or-uninstall-fonts)
17+
* [Linux/Unix-based systems](https://github.com/adobe/source-code-pro/issues/17#issuecomment-8967116)
2118

22-
Building Font Binaries
23-
====
19+
## Building from source
2420

25-
Requirements
26-
----
21+
### Requirements
2722

28-
To build the binary font files from source, you need to have installed the [Adobe Font Development Kit for OpenType](http://www.adobe.com/devnet/opentype/afdko.html) (AFDKO). The AFDKO tools are widely used for font development today, and are part of most font editor applications.
23+
To build the binary font files from source, you need to have installed the
24+
[Adobe Font Development Kit for OpenType](http://www.adobe.com/devnet/opentype/afdko.html) (AFDKO). The AFDKO
25+
tools are widely used for font development today, and are part of most font
26+
editor applications.
2927

30-
Building one font
31-
----
28+
### Building one font
3229

33-
Key to building OTF or TTF fonts is `makeotf`, which is part of the AFDKO toolset.
30+
The key to building OTF or TTF fonts is `makeotf`, which is part of the AFDKO toolset.
3431
Information and usage instructions can be found by executing `makeotf -h`.
3532

3633
In this repository, all necessary files are in place for building the OTF and TTF fonts.
3734
For example, build a binary OTF font for the Regular style like this:
3835

39-
$ cd Roman/Regular/
36+
$ cd Roman/Regular/
4037
$ makeotf -r
4138

42-
43-
Building all fonts
44-
----
39+
### Building all fonts
4540

4641
For convenience, a shell script named `build.sh` is provided in the root directory.
4742
It builds all OTFs and TTFs, and can be executed by typing:
4843

4944
$ ./build.sh
5045

46+
## Getting Involved
5147

52-
Installing
53-
====
48+
Send suggestions for changes to the Source Code OpenType font project maintainer,
49+
[email protected], for consideration.
5450

55-
[Font Installation Instructions for Windows and Mac](http://www.adobe.com/type/browser/fontinstall/instructions_english.html)
5651

57-
[Font Installation Instructions for Unix-based systems](https://github.com/adobe/source-code-pro/issues/17#issuecomment-8967116)
5852

0 commit comments

Comments
 (0)