Skip to content

Commit 29bd767

Browse files
committed
Added AppVeyor information
1 parent 8e8c8c2 commit 29bd767

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

README.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,46 @@
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 be installed. 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 allows 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. 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.
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

11-
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/)).
11+
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/)).
12+
13+
## Setup experience
14+
15+
- Uses downloads `(ExeFile).exe` from your repository and double clicks it.
16+
- 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
19+
- **SCREENSHOT**
20+
- `(ExeFile).exe` asks the user to perform a restart
21+
- Font can be used.
22+
23+
To uninstall, the user goes to the *Add/Remove Programs* applet in Control Panel, selects the entry and clicks on *Remove*.
24+
**SCREENSHOT**
25+
26+
27+
## How to use it
28+
29+
## AppVeyor
30+
31+
[AppVeyor](https://www.appveyor.com/) is a continuous integration (CI) service that provides a Windows based environment. It can be used to build the EXE file if you do not have access to a Windows installation. It can be freely used for open source projects.
32+
33+
To use it, do the following:
34+
- Clone this repository
35+
- Delete the test fonts and exchange them for your your own `*.TTF` files
36+
- Update the other files as you see fitr (e.g. License.txt)
37+
- Update *DATA.ini* to match your font(s), copyright information etc.
38+
- Create an account at [AppVeyor](https://www.appveyor.com/) (You can login using your GitHub account)
39+
- Click on the *Projects* tab
40+
- Click *NEW PROJECT*
41+
- Select your repository in the last and click *Add*
42+
- Push to your repository and AppVeyor will create the setup EXE for you automatically (might take some minutes)
43+
- You can download the EXE file by selecting your project, clicking on *LATEST BUILD* and selecting *ARTIFACTS*
44+
1245

1346

1447
## License

0 commit comments

Comments
 (0)