Skip to content

Commit

Permalink
update readme to nudge towards nix
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelglass committed Nov 13, 2024
1 parent 82ec29f commit 756cef2
Showing 1 changed file with 23 additions and 10 deletions.
33 changes: 23 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,22 +122,35 @@ require Rails.root.join('edge', 'spec', 'edge_helper')

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
This project uses nix to manage the dev environment.

To install this gem onto your local machine, run `bundle exec rake install`.
This project additionally uses
- [direnv](https://github.com/direnv/direnv)
- flakes

To release a new version, follow the instructions in [PUBLISHING.md](PUBLISHING.md).
If you don't have flakes enabled, you can enable them by adding `experimental-features = flakes` to your `~/.config/nix/nix.conf` file.
(or running )

### Nix support
typing `direnv allow` loads the dev environment including a compatible ruby, sqlite, and gems.

In order to get Nix working you need to have [direnv](https://github.com/direnv/direnv) installed. You will have to `direnv allow` to load the current `.envrc`. You can then run from the top level folder:
To modify gem dependencies, use the bundle wrappers
- `bundle-lock` to update the lockfile
- `bundle-update` to update gems & the lockfile
then run `bundix` to update the `gemset.nix` file.

```
bundle-update
bundix
```
### Usage Without Nix

Usage without nix is unsupported but may work anyways. Try the following:

to update gems & update the gemset.nix
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`.

Note: We only support adding gems and dependencies using nix.

### Publishing

To release a new version, follow the instructions in [PUBLISHING.md](PUBLISHING.md).

## Contributing

Expand Down

0 comments on commit 756cef2

Please sign in to comment.