More README info
This commit is contained in:
parent
44132362e5
commit
5b12f0a788
34
README.md
34
README.md
|
@ -9,10 +9,21 @@ nix flake init --template github:the-nix-way/dev-templates#${ENV}
|
|||
Here's an example (for the [`rust`](./rust) template):
|
||||
|
||||
```shell
|
||||
# Initialize in the current project
|
||||
nix flake init --template github:the-nix-way/dev-templates#rust
|
||||
|
||||
# Create a new project
|
||||
nix flake new --template github:the-nix-way/dev-templates#rust ${NEW_PROJECT_DIRECTORY}
|
||||
```
|
||||
|
||||
Available templates:
|
||||
## How to use the templates
|
||||
|
||||
Once your preferred template has been initialized, you can use the provided shell in two ways:
|
||||
|
||||
1. If you have [`nix-direnv`][nix-direnv] installed, you can initialize the environment by running `direnv allow`.
|
||||
2. If you don't have `nix-direnv` installed, you can run `nix develop` to open up the Nix-defined shell.
|
||||
|
||||
## Available templates
|
||||
|
||||
| Language/framework/tool | Template |
|
||||
| :---------------------- | :------------------------ |
|
||||
|
@ -30,6 +41,26 @@ Available templates:
|
|||
| [Scala] | [`scala`](./scala/) |
|
||||
| [Zig] | [`zig`](./zig/) |
|
||||
|
||||
## Template contents
|
||||
|
||||
The sections below list what each template includes.
|
||||
|
||||
### `dhall`
|
||||
|
||||
- [Dhall]
|
||||
- [`dhall-bash`](https://github.com/dhall-lang/dhall-haskell/tree/master/dhall-bash)
|
||||
- [`dhall-csv`](https://github.com/dhall-lang/dhall-haskell/tree/master/dhall-csv) (Linux only)
|
||||
- [`dhall-docs`](https://github.com/dhall-lang/dhall-haskell/tree/master/dhall-docs)
|
||||
- [`dhall-haskell`](https://github.com/dhall-lang/dhall-haskell/tree/master/dhall-haslekk) (Linux only)
|
||||
- [`dhall-json`](https://github.com/dhall-lang/dhall-haskell/tree/master/dhall-json)
|
||||
- [`dhall-lsp-server`](https://github.com/dhall-lang/dhall-haskell/tree/master/dhall-lsp-server)
|
||||
- [`dhall-nix`](https://github.com/dhall-lang/dhall-haskell/tree/master/dhall-nix)
|
||||
- [`dhall-nixpkgs`](https://github.com/dhall-lang/dhall-haskell/tree/master/dhall-nixpkgs)
|
||||
- [`dhall-openapi`](https://github.com/dhall-lang/dhall-haskell/tree/master/dhall-openapi)
|
||||
- [`dhall-text`](https://github.com/dhall-lang/dhall-haskell/tree/master/dhall-text) (Linux only)
|
||||
- [`dhall-toml`](https://github.com/dhall-lang/dhall-haskell/tree/master/dhall-toml)
|
||||
- [`dhall-yaml`](https://github.com/dhall-lang/dhall-haskell/tree/master/dhall-yaml)
|
||||
|
||||
[dhall]: https://dhall-lang.org
|
||||
[elixir]: https://elixir-lang.org
|
||||
[gleam]: https://gleam.run
|
||||
|
@ -37,6 +68,7 @@ Available templates:
|
|||
[java]: https://java.com
|
||||
[kotlin]: https://kotlinlang.org
|
||||
[nix]: https://nixos.org
|
||||
[nix-direnv]: https://github.com/nix-community/nix-direnv
|
||||
[node]: https://nodejs.org
|
||||
[protobuf]: https://developers.google.com/protocol-buffers
|
||||
[rust]: https://rust-lang.org
|
||||
|
|
Loading…
Reference in a new issue