Skip to content

Commit

Permalink
[README.md] Update instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
lgarron committed Jan 2, 2025
1 parent b1c503f commit d69671e
Showing 1 changed file with 24 additions and 9 deletions.
33 changes: 24 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,36 @@
# Cubing Icons and Fonts
# Cubing icons and fonts

[![Deploy to GitHub Pages](https://github.com/cubing/icons/actions/workflows/deploy.yml/badge.svg)](https://github.com/cubing/icons/actions/workflows/deploy.yml)
## Documentation and demo

## Demo
<https://icons.cubing.net>

## Rebuild fonts and cubing-icons.css
## Development

We use the excellent [gulp-iconfont](https://www.npmjs.com/package/gulp-iconfont).
Most development is simply adding/changing existing SVG files. If you haven't dealt
with SVG files before, check out [Inkscape](https://inkscape.org/).

- `npm install`
- Install [potrace](http://potrace.sourceforge.net/).
- `npm run build` or `npm run watch` - Open `www/index.html` in your web browser.
If you want to actually build a font or CSS locally, you'll need some more tooling.
The easiest way to get those tools is with [nix](https://nixos.org/). You'll
need the experimental [Flakes](https://wiki.nixos.org/wiki/Flakes) feature
enabled.

## Build the project

This project uses [`bun`](https://bun.sh/) for development.. If you have `bun` installed, you can run:

```shell
git clone https://github.com/cubing/icons && cd icons
make
# Files are build into the `./dist` dir
```

### Develop using `nix`

TODO: adapt `nix` info.

## Releasing

### Bump version and deploy to npmjs
### Bump version and deploy to `npmjs.org`

```
npm version major|minor|patch -m "Upgrade to %s for reasons"
Expand Down

0 comments on commit d69671e

Please sign in to comment.