Skip to content

Commit 47f2ee5

Browse files
committed
[README.md] replace README docs with links to new documentation static site
1 parent 70ddd56 commit 47f2ee5

File tree

1 file changed

+13
-90
lines changed

1 file changed

+13
-90
lines changed

README.md

Lines changed: 13 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -1,108 +1,31 @@
11
# <img height="36" src="https://raw.githubusercontent.com/source-foundry/Slice/main/src/resources/img/slice-icon.svg"/> Slice
22

3-
### An open-source application to create custom static fonts from variable fonts
3+
### An open-source application to create custom font design spaces from variable fonts
44

55
<img src="https://d33wubrfki0l68.cloudfront.net/d67ed997178c60733041aaaf932bdf9c3afcb63b/fda62/images/slice-hero-crunch.png">
66

77
## About
88

9-
Slice is a GUI application that takes a variable font and compiles a new custom "slice" of the variable design space with user-defined design axis values. This output file is commonly known as a "static instance" font in type software developer parlance. The application supports custom font family naming so that you can view output files as different families in application menus.
9+
Slice is an open-source, cross-platform GUI app that generates fonts with custom design sub-spaces from variable font inputs.
1010

11-
Slice is built with PyQt5 and supports cross-platform use on macOS, Windows, and Linux. Static instance fonts are generated with the [fonttools Python library](https://github.com/fonttools/fonttools). The application is free software. Please see the Licenses section below for additional details.
11+
## User documentation
1212

13-
If you are a licensed user of the font that you intend to edit, please understand your font license before you use this application!
13+
User docs are available at https://slice-gui.netlify.app/docs/
1414

15-
## Use case examples
15+
- [Installation](https://slice-gui.netlify.app/docs/install/)
16+
- [Usage](https://slice-gui.netlify.app/docs/usage/)
1617

17-
- You want to use a font, file size optimization is important, and you only need a small subset of a variable font design space
18-
- You want to use a font in an application that lacks support for, or only partially supports, the variable font format
19-
- You want to use fonts that cover different areas of the design space and have different family names for A/B testing
20-
- You develop type software and want to easily generate multiple static instances of your variable design space to support the client or reviewer review process
18+
## Issues
2119

22-
## Installation
23-
24-
Install the application on your platform with the following instructions.
25-
26-
### [macOS]()
27-
28-
#### Install with Homebrew
29-
30-
[Homebrew](https://brew.sh/) users can use our custom tap to install, upgrade, and remove Slice.
31-
32-
Use the following commands to install:
33-
34-
```sh
35-
$ brew tap source-foundry/taproom
36-
$ brew update
37-
$ brew install --cask sourcefoundry-slice
38-
```
39-
40-
Homebrew will update Slice to new releases during the `brew update && brew upgrade` process. Use `brew upgrade sourcefoundry-slice` to upgrade the Slice application only.
41-
42-
Use the following command to uninstall:
43-
44-
```
45-
$ brew uninstall sourcefoundry-slice
46-
```
47-
48-
#### Install with dmg Installer
49-
50-
Download the [latest macOS dmg installer](https://github.com/source-foundry/Slice/releases/latest) in our Releases.
51-
52-
Launch the installer and acknowledge the license during the install process. Drag and drop the Slice.app bundle into your Applications directory when the installer prompts you to do so. Open Launchpad and launch Slice by clicking the icon.
53-
54-
### [Linux]()
55-
56-
Arch Linux users can install the [slice AUR package](https://aur.archlinux.org/packages/slice/).
57-
58-
Other Linux packages are in development.
59-
For now, please use the following instructions to run from the sources.
60-
61-
Clone the repository with:
62-
63-
```
64-
$ git clone https://github.com/source-foundry/Slice.git
65-
```
66-
67-
Create a Python 3.6+ virtual environment with:
68-
69-
```
70-
$ cd Slice
71-
$ python3 -m venv .venv
72-
```
73-
74-
Install the required build dependencies with:
75-
76-
```
77-
$ source .venv/bin/activate
78-
$ pip install -r requirements.txt
79-
```
80-
81-
Run the application with:
82-
83-
```
84-
$ make run
85-
```
86-
87-
### [Windows]()
88-
89-
Download the [latest Windows .exe installer](https://github.com/source-foundry/Slice/releases/latest) in our Releases.
90-
91-
Launch the installer, acknowledge the license, and follow the instructions. When the install process completes, type "Slice" in the Win 10 Search bar and launch the application (or click the desktop icon if you chose to install it during the installation process).
92-
93-
## Usage
94-
95-
1. Drag and drop a variable font file onto the Font Path free text entry area. Your variable font axis names with associated min, max, and default axis values display in the Axis Definitions editor table.
96-
2. Click the Instance Value fields of the Axis Definitions editor table and set the desired values. Default axis tag values are used when you leave a field blank.
97-
3. Edit the Name Table Definitions fields to define the menu names for your instance slice. Refer to the [OpenType specification name table documentation](https://docs.microsoft.com/en-us/typography/opentype/spec/name) for additional details about how to set these values.
98-
4. Use the checkboxes at the bottom of the application window to set the appropriate bits. Checkboxes that are not clicked indicate that you want the bit cleared. Refer to the OpenType specification [head](https://docs.microsoft.com/en-us/typography/opentype/spec/head) and [OS/2](https://docs.microsoft.com/en-us/typography/opentype/spec/os2) table documentation for additional details.
99-
5. Click the Slice button and enter a save path in the dialog window. The status bar in the bottom left corner of the main application window will indicate when your new slice is ready.
20+
Please file issues on the [project tracker](https://github.com/source-foundry/Slice/issues).
10021

10122
## Contributing
10223

103-
Please file issues on the [project tracker](https://github.com/source-foundry/Slice/issues).
24+
Source contributions are welcome. Please see the [Slice application developer documentation](https://slice-gui.netlify.app/docs/developer/#slice-source-code-contributions) for instructions on how to set up a local development environment and test your source changes. Submit a pull request with any changes that you would like to share upstream.
25+
26+
The Slice documentation is maintained in a separate GitHub repository. Please see the [Slice documentation developer documentation](https://slice-gui.netlify.app/docs/developer/#slice-documentation-contributions) for additional details about how to modify documentation content and set up a local testing environment.
10427

105-
Source contributions are welcome. Please see the [DEVELOPER.md](DEVELOPER.md) documentation for instructions on how to set up a development environment and test source changes. Submit a pull request with any changes that you would like to share upstream.
28+
Contributions to this project are accepted under the licenses specified in the [Licenses](#Licenses) section below.
10629

10730
## Licenses
10831

@@ -112,7 +35,7 @@ Please see the [thirdparty directory](https://github.com/source-foundry/Slice/tr
11235

11336
## Acknowledgments
11437

115-
❤️ Slice slices with the fantastic fonttools Python library.
38+
❤️ Slice slices with the fantastic [fonttools Python library](https://github.com/fonttools/fonttools).
11639

11740
⚡ Slice docs are powered by Netlify.
11841

0 commit comments

Comments
 (0)