diff options
author | github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> | 2021-10-30 18:01:37 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-10-30 18:01:37 +0000 |
commit | 062a1496d614fedc66dab048b299d3259296af00 (patch) | |
tree | 5424d6c3c0f908c57e8841552c75e88accabd5c2 /doc | |
parent | 230a785370eea8a39c964b1464ba43cfc9f03e3f (diff) | |
parent | 0fa76ebdcadc9a05cfc0b5ac4688d7fcde01171a (diff) | |
download | nixlib-062a1496d614fedc66dab048b299d3259296af00.tar nixlib-062a1496d614fedc66dab048b299d3259296af00.tar.gz nixlib-062a1496d614fedc66dab048b299d3259296af00.tar.bz2 nixlib-062a1496d614fedc66dab048b299d3259296af00.tar.lz nixlib-062a1496d614fedc66dab048b299d3259296af00.tar.xz nixlib-062a1496d614fedc66dab048b299d3259296af00.tar.zst nixlib-062a1496d614fedc66dab048b299d3259296af00.zip |
Merge staging-next into staging
Diffstat (limited to 'doc')
-rw-r--r-- | doc/languages-frameworks/crystal.section.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/languages-frameworks/crystal.section.md b/doc/languages-frameworks/crystal.section.md index cbe31f9f0b2f..cbabba24f0c1 100644 --- a/doc/languages-frameworks/crystal.section.md +++ b/doc/languages-frameworks/crystal.section.md @@ -4,12 +4,12 @@ This section uses [Mint](https://github.com/mint-lang/mint) as an example for how to build a Crystal package. -If the Crystal project has any dependencies, the first step is to get a `shards.nix` file encoding those. Get a copy of the project and go to its root directory such that its `shard.lock` file is in the current directory, then run `crystal2nix` in it - +If the Crystal project has any dependencies, the first step is to get a `shards.nix` file encoding those. Get a copy of the project and go to its root directory such that its `shard.lock` file is in the current directory. Executable projects should usually commit the `shard.lock` file, but sometimes that's not the case, which means you need to generate it yourself. With an existing `shard.lock` file, `crystal2nix` can be run. ```bash $ git clone https://github.com/mint-lang/mint $ cd mint $ git checkout 0.5.0 +$ if [ ! -f shard.lock ]; then nix-shell -p shards --run "shards lock"; fi $ nix-shell -p crystal2nix --run crystal2nix ``` |