You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -64,44 +60,55 @@ To make this developer shell available in VSCode DevContainer or GitHub CodeSpac
64
60
```
65
61
This configuration will work immediately in GitHub CodeSpace! For local VSCode DevContainer, you need Docker and the [VSCode extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). For guidance on this, you can follow the [Microsoft tutorial](https://code.visualstudio.com/docs/devcontainers/tutorial).
66
62
67
-
It's also advise to enable GitHub CodeSpace prebuilds in your repository settings, follow the instructions provided in the [GitHub documentation](https://docs.github.com/en/codespaces/prebuilding-your-codespaces/configuring-prebuilds). This will significantly enhance your development experience by reducing the setup time when opening a new CodeSpace.
63
+
It's also advised to enable GitHub CodeSpace prebuilds in your repository settings, follow the instructions provided in the [GitHub documentation](https://docs.github.com/en/codespaces/prebuilding-your-codespaces/configuring-prebuilds). This will significantly enhance your development experience by reducing the setup time when opening a new CodeSpace.
68
64
69
-
List of images available: `ghc810-iog`, `ghc96-iog`, `ghc810-js-iog`, `ghc96-js-iog`, `ghc810-windows-iog`, `ghc96-windows-iog`
65
+
List of images available: `ghc810-iog`, `ghc96-iog`, `ghc810-js-iog`, `ghc96-js-iog`, `ghc810-windows-iog`, `ghc96-windows-iog`.
70
66
71
-
## Compilers and Flavours
67
+
## Compilers and Flavors
72
68
73
69
There are multiple compilers available, and usually the latest for each series
74
70
from 8.10 to 9.6 (a slight delay between the official release announcement and
75
71
the compiler showing up in the devx shell is expected due to integration work
76
-
necessary). The current available ones are: `ghc810`, `ghc90`, `ghc92`,`ghc94`, and
72
+
necessary). The current available ones are: `ghc810`, `ghc90`, `ghc92`,`ghc94`, and
77
73
`ghc96` (these are the same ones as in [haskell.nix](https://github.com/input-output-hk/haskell.nix) and may contain patches for defects in the official releases).
78
74
79
-
### Flavours
80
-
There are various flavours available as suffixes to the compiler names (e.g. `#ghc810-minimal-iog`).
75
+
### Flavors
76
+
77
+
There are various flavors available as suffixes to the compiler names (e.g. `#ghc810-minimal-iog`).
81
78
82
-
|Flavour| Description | Example | Included |
79
+
|Flavor| Description | Example | Included |
83
80
| - | - | - | - |
84
81
| empty | General Haskell Dev |`#ghc810`|`ghc`, `cabal-install`, `hls`, `hlint`|
would provide a development shell with a windows crosscompiler as well as cabal, and the IOG specific libraries, but no Haskell Language Server (hls), and no HLint.
96
+
... would provide a development shell with a windows cross-compiler as well as cabal, and the IOG specific libraries, but no Haskell Language Server (`hls`), and no HLint.
100
97
101
-
A full list of all available `devShells` can be see with:
98
+
A full list of all available `devShells` can be seen with:
102
99
```bash
103
100
nix flake show github:input-output-hk/devx
104
101
```
105
102
103
+
## To Go Further
104
+
105
+
### Customizing with `haskell.nix`
106
+
107
+
The `devx` shell utilizes `haskell.nix` for a consistent development environment across platforms. Direct use of `haskell.nix` allows for greater customization by adapting Nix expressions to specific project needs, `haskell.nix` turn a Cabal or Stack projects into a Nix expression. For more details, see the [`haskell.nix` documentation](https://input-output-hk.github.io/haskell.nix/).
108
+
109
+
### Automating with IOG GitHub Actions
110
+
111
+
The `devx` GitHub Action, alongside other IOG-provided actions, supports automated workflows for Haskell projects. More information can be found in the [IOG GitHub Actions repository](https://github.com/input-output-hk/actions).
112
+
106
113
> [!NOTE]
107
114
> For commercial support, please don't hesitate to reach out at [email protected]
0 commit comments