Skip to content

Commit 320540d

Browse files
committed
Changed step-by-step description
1 parent 361903f commit 320540d

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@
22

33
Font Setup Creator for Windows (FSCW) is a a toolkit to create a Windows desktop setup for fonts.
44

5-
It is driven by a [DATA.ini](https://github.com/source-foundry/fscw/blob/master/src/Data.ini) file that includes all necessary information about the font(s) to install. The Setup EXE file is automatically generated using [Inno Setup](http://www.jrsoftware.org/isinfo.php). If you do not run Windows, a build script for [AppVeyor](https://www.appveyor.com/) is also included. This will cause AppVeyor to build the Setup EXE for you each time you push to your repository.
5+
It is driven by a [DATA.ini](https://github.com/source-foundry/fscw/blob/master/src/Data.ini) file that includes all necessary information about the font(s) to install and uses [Inno Setup](http://www.jrsoftware.org/isinfo.php) to generate the Setup.exe file. If you do not run Windows, a build script for [AppVeyor](https://www.appveyor.com/) is also included. AppVeyor can build the Setup EXE automatically each time you push to your repository.
66

77
## Why this project exists
88

99
FSCW includes all best practises for font installation on Windows we have learned while creating the [Windows installer](https://github.com/source-foundry/Hack-windows-installer) for the [Hack typeface](https://github.com/chrissimpkins/Hack).
1010

1111
Although it might seem like overkill to use a Windows installer for fonts, there is good reason for this on the Windows platform. A number of things can go wrong when one tries to install or update frequently updated fonts manually (see [issue #152](https://github.com/chrissimpkins/Hack/issues/152) and [issue #129](https://github.com/chrissimpkins/Hack/issues/129) in the [Hack repository](https://github.com/chrissimpkins/Hack/)).
1212

13-
## Setup experience for the generated setup
13+
## Setup experience
1414

1515
- Uses downloads `(SetupExe)` from your repository and double clicks it.
1616
- User sees a *Windows protected your PC* message, clicks on `More info` and selects `Run anyway`.
17-
- **Note:** The appearing *Windows SmartScreen warning* can be safely ignored as it is caused only by the fact that the EXE is not digitally signed. You may want to upload the EXE file to [VirusTotal](http://www.virustotal.com) and link to the report from your repository.
18-
- User asks if the font(s) should be installed
17+
- **Note:** This *Windows SmartScreen warning* can be safely ignored as it is caused only by the fact that the EXE is not digitally signed. You may want to upload the EXE file to [VirusTotal](http://www.virustotal.com) and link to the report from your repository.
18+
- User is asked if the font(s) should be installed
1919
- **SCREENSHOT**
2020
- `(SetupExe)` asks the user to perform a restart
2121
- Font can be used.
@@ -31,8 +31,10 @@ To uninstall, the user goes to the *Add/Remove Programs* applet in Control Panel
3131
- Update `src/DATA.ini` to match your own data (Name, copyright etc.)
3232
- **NOTE** Please always remember to update `UniqueID` in `src/DATA.ini`
3333

34+
3435
## Building on Windows
3536

37+
- Perform the steps described in [How to use it](#how-to-use-it)
3638
- Download [Inno Setup](http://www.jrsoftware.org/isinfo.php)
3739
- Please make sure the option "Inno Setup Prepocessor" is activated during install
3840
- Open `src\FSCW.iss`
@@ -43,15 +45,11 @@ To uninstall, the user goes to the *Add/Remove Programs* applet in Control Panel
4345

4446
[AppVeyor](https://www.appveyor.com/) is a continuous integration (CI) service that provides a Windows based environment and can be freely used for open source projects. You can use it to build `(SetupExe)` if you do not have access to a Windows installation.
4547

46-
To use it, do the following:
47-
- Clone this repository
48-
- Delete the test fonts and exchange them for your your own `*.TTF` files
49-
- Update the other files as you see fitr (e.g. License.txt)
50-
- Update *DATA.ini* to match your font(s), copyright information etc.
48+
- Perform the steps described in [How to use it](#how-to-use-it)
5149
- Create an account at [AppVeyor](https://www.appveyor.com/) (You can login using your GitHub account)
52-
- Click on the *Projects* tab
50+
- Click on the *PROJECTS* tab
5351
- Click *NEW PROJECT*
54-
- Select your repository in the last and click *Add*
52+
- Select your repository and click *Add*
5553
- Push to your repository and AppVeyor will create the setup EXE for you automatically (might take some minutes)
5654
- You can download the EXE file by selecting your project, clicking on *LATEST BUILD* and selecting *ARTIFACTS*
5755

0 commit comments

Comments
 (0)