Repository files navigation

https://icons.cubing.net

Most development is simply adding/changing existing SVG files under the./src/svg directory. Ifyou haven't dealt with SVG files before, check outInkscape.

If you want to actually build a font or CSS locally, you'll need some more tooling.

You'll needbun to install development dependencies andbuild the project. Check out and build the project as follows:

git clone https://github.com/cubing/icons&&cd iconsmake

Files are build into the./dist dir.

We provide anix shell that you can activate with:nix develop

package-lock.json is the source of truth. Usenpm to change dependencies(if all you're doing is installing dependencies, you don't neednpm).

As soon asnix getssupport forbunlockfiles, we can remove thisquirk.

To bump the version and deploy tonpmjs.org:

npm version [major|minor|patch] -m"Release description"git push --follow-tagsmake publish

Note thatcdn.cubing.net requires an explicit version bump and deployment in order to pick up the new@cubing/icons version:

git clone https://github.com/cubing/cdn.cubing.net&&cd cdn.cubing.net# Requires SSH and optional Fastly credentials to deploymake roll-@cubing/icons