Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@tamcy
tamcy committed Jul 26, 2024
1 parent efe7258 commit ca043ea
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 4 deletions.
9 changes: 7 additions & 2 deletions README.en.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ Download the font from the [Github Releases](https://github.com/chiron-fonts/chi
* TrueType format, static instances (`TTF/` directory)
* OpenType format, static instances (`OTF/` directory)
* Variable Font in TrueType or OpenType format (`VAR/` directory)
* Webfont version in WOFF2 format (`WEBFONT/` directory)
* Webfont version in OpenType WOFF2 format (`WOFF2_OTF/` directory)
* Webfont version in TrueType WOFF2 format (`WOFF2_TTF/` directory)

The font family name is *Chiron Sung HK* for static instances, and *Chiron Sung HK VF* for the variable font configuration. Use the *Chiron Sung HK WS* font family name for the webfont version (see below).

Expand All @@ -27,13 +28,17 @@ Besides manually downloading the font from the GitHub Releases page, there are t

1. Self-hosting

Install the [npm package](https://www.npmjs.com/package/chiron-sung-hk-webfont) and import the CSS files. For example:
Install the [chiron-sung-hk-webfont npm package](https://www.npmjs.com/package/chiron-sung-hk-webfont) and import the CSS files. For example:

```css
@import '~chiron-sung-hk-webfont/css/vf.css';
@import '~chiron-sung-hk-webfont/css/vf-italic.css';
```

For TrueType outline, install the [chiron-sung-hk-webfont-truetype npm package](https://www.npmjs.com/package/chiron-sung-hk-webfont-truetype) instead, and change the import module name from `chiron-sung-hk-webfont` to `chiron-sung-hk-webfont-truetype`.

```css

2. CDN

Visit the [jsDeliver](https://www.jsdelivr.com/package/npm/chiron-sung-hk-webfont?path=css) webpage, add the desired font styles to the collection, and retrieve the CSS import statements. *Note: do not enable the option that will merge all the selected styles into a single file. This will not work.*
Expand Down
6 changes: 4 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

### 桌面環境

前往[本專案的 Github Releases](https://github.com/chiron-fonts/chiron-sung-hk/releases/latest) 頁查看/下載最新版本，然後安裝至作業系統即可使用。字體提供多種格式，包括靜態版 TrueType (`TTF/`目錄)、靜態版OpenType (`OTF/`目錄)、TrueType 和 OpenType 可變式字型 (`VAR/`目錄)。另外，壓縮包亦包括供網頁使用的 WOFF2 網頁字型檔 (`WEBFONT/`目錄)。
前往[本專案的 Github Releases](https://github.com/chiron-fonts/chiron-sung-hk/releases/latest) 頁查看/下載最新版本，然後安裝至作業系統即可使用。字體提供多種格式，包括靜態版 TrueType (`TTF/` 目錄)、靜態版OpenType (`OTF/` 目錄)、TrueType 和 OpenType 可變式字型 (`VAR/` 目錄)。另外，壓縮包亦包括供網頁使用的 WOFF2 網頁字型檔 (`WOFF2_OTF/` 或 `WOFF2_TTF` 目錄，分別採用 OpenType 及 TrueType 外框格式)。

靜態版字型安裝後的字體名稱是 Chiron Sung HK，可變式字型則是 Chiron Sung HK VF。

Expand All @@ -28,7 +28,9 @@
@import '~chiron-sung-hk-webfont/css/vf-italic.css';
```

2. 利用 CDN 服務獲得本字體：前往 [jsDeliver](https://www.jsdelivr.com/package/npm/chiron-sung-hk-webfont?path=css) 網站並加入要使用的樣式，再根據指示匯入所需的 CSS 檔案。*注意：不要選擇將所有檔案合成單一檔案的選項，這會令 CSS 樣式無法運作。*
如要使用 TrueType 外框版本，則可安裝 [chiron-sung-hk-webfont-truetype npm 套件](https://www.npmjs.com/package/chiron-sung-hk-webfont-truetype)，並將匯入名稱從 `chiron-sung-hk-webfont` 改為 `chiron-sung-hk-webfont-truetype`。

2. 利用 CDN 服務獲得本字體：前往 [jsDeliver](https://www.jsdelivr.com/package/npm/chiron-sung-hk-webfont?path=css) （[TrueType](https://www.jsdelivr.com/package/npm/chiron-sung-hk-webfont-truetype?path=css) 版本）網站並加入要使用的樣式，再根據指示匯入所需的 CSS 檔案。*注意：不要選擇將所有檔案合成單一檔案的選項，這會令 CSS 樣式無法運作。*

用例：
```css
Expand Down

0 comments on commit ca043ea

Please sign in to comment.