Skip to content

Commit

Permalink
add maplibre files; fix gh-pages dir
Browse files Browse the repository at this point in the history
  • Loading branch information
bdon committed Nov 24, 2022
1 parent 3eba90b commit 42364fd
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 15 deletions.
2 changes: 2 additions & 0 deletions .github/funding.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
github: [maplibre]
open_collective: maplibre
2 changes: 1 addition & 1 deletion .github/workflows/actions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,6 @@ jobs:
if: ${{ github.ref == 'refs/heads/main' }}
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./app/dist
publish_dir: ./dist
force_orphan: true

11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Building

If you want to compile the WebAssembly components from scratch, you'll need the following:

* The [Emscripten SDK](https://emscripten.org/docs/getting_started/downloads.html) installed and activated on your machine (`emcc` on your path)
* A [boost](https://www.boost.org) installation on your machine

Clone this repository and all submodules with `git clone --recursive`

Use `./build.sh PATH_TO_INCLUDE_DIR` to build the WASM output, where `PATH_TO_INCLUDE_DIR` is the directory of your local Boost install.

1 change: 1 addition & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
Copyright (c) 2022 MapLibre contributors
Copyright (c) 2019-2022, Protomaps LLC
Copyright (c) 2014, Mapbox
All rights reserved.
Expand Down
14 changes: 0 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ Generates Signed Distance Field fonts for use in MapLibre GL, Mapbox GL, etc.

Simply upload a font and convert; it runs 100% client-side via WebAssembly.

There is as little code here as possible, most of it is taken from [node-fontnik](https://github.com/mapbox/node-fontnik).

## Usage

Go to the web app at [protomaps.github.io/sdf-glyph-tool/](https://protomaps.github.io/sdf-glyph-tool/) and select your file. Wait for the progress bar to complete and download your ZIP.
Expand All @@ -14,21 +12,9 @@ Go to the web app at [protomaps.github.io/sdf-glyph-tool/](https://protomaps.git

You don't need to install anything to create SDF fonts, just use the page above.

If you want to compile the WebAssembly components from scratch, you'll need the following:

* The [Emscripten SDK](https://emscripten.org/docs/getting_started/downloads.html) installed and activated on your machine (`emcc` on your path)
* A [boost](https://www.boost.org) installation on your machine

Clone this repository and all submodules with `git clone --recursive`

Use `./build.sh PATH_TO_INCLUDE_DIR` to build the WASM output, where `PATH_TO_INCLUDE_DIR` is the directory of your local Boost install.

## Variants

By specifying a font file you can control which variants are used for these scripts:

* Cyriac (Eastern/Western/Estrangela)
* Han (kr/hk/cn/tw/jp/vn)

## TODO
* Combine multiple font files

0 comments on commit 42364fd

Please sign in to comment.