Skip to content

Commit

Permalink
Merge pull request #140 from cubing/lgarron/copyable-plain-bun
Browse files Browse the repository at this point in the history
Update dev instructions so they can be copied for plain `bun`
  • Loading branch information
lgarron authored Jan 3, 2025
2 parents 72ecf0e + e2ee40a commit 1b862ce
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,20 @@ If you want to actually build a font or CSS locally, you'll need some more tooli

### Build the project

You'll need [`bun`](https://bun.sh) to install development dependencies and build the project.

If you don't have `bun` installed, we provide a [`nix`](https://nixos.org/)
shell you can activate with `nix develop`.
You'll need [`bun`](https://bun.sh) to install development dependencies and
build the project. Check out and build the project as follows:

```shell
git clone https://github.com/cubing/icons && cd icons
nix develop # Optional. See above.
make
```

Files are build into the `./dist` dir.

### Using `nix` for development (optional)

We provide a [`nix`](https://nixos.org/) shell that you can activate with: `nix develop`

### Upgrading/changing dependencies

`package-lock.json` is the source of truth. Use `npm` to change dependencies
Expand Down

0 comments on commit 1b862ce

Please sign in to comment.