Skip to content

Commit cf81281

Browse files
committed
Bump Plutip/BPI stack to stable and augment README
1 parent fe2946b commit cf81281

File tree

3 files changed

+43
-22
lines changed

3 files changed

+43
-22
lines changed

README.md

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -103,13 +103,39 @@ Download the Git repository:
103103
git clone https://github.com/mlabs-haskell/cardano-open-oracle-protocol.git
104104
```
105105

106-
If you use [direnv](https://direnv.net/) the Nix development shells will be
107-
automatically loaded depending on which project part you're working on.
106+
To facilitate seamlessly moving between directories and associated Nix
107+
development shells we use [direnv](https://direnv.net) and
108+
[nix-direnv](https://github.com/nix-community/nix-direnv):
109+
110+
To install both using `nixpkgs`:
111+
112+
```sh
113+
nix profile install nixpkgs#direnv
114+
nix profile install nixpkgs#nix-direnv
115+
```
116+
117+
Your shell and editors should pick up on the `.envrc` files in different
118+
directories and prepare the environment accordingly. Use `direnv allow` to
119+
enable the direnv environment and `direnv reload` to reload it when necessary.
108120
Otherwise, each `.envrc` file in COOP sub-directories contain a proper Nix
109-
target you can use with the `nix develop` command.
121+
target you can use with the `nix develop` command. For example `nix develop #dev-pab` will build a Nix development shell that has everything needed for
122+
developing and compiling the `coop-pab` component.
123+
124+
Additionally, throughout the repository one can use the [pre-commit](https://pre-commit.com/) tool:
110125

111-
For example `nix develop #dev-pab` will build a Nix development shell that has
112-
everything needed for developing and compiling the `coop-pab` component.
126+
```sh
127+
$ pre-commit run --all
128+
cabal-fmt................................................................Passed
129+
fourmolu.................................................................Passed
130+
hlint....................................................................Passed
131+
markdownlint.............................................................Passed
132+
nix-linter...............................................................Passed
133+
nixpkgs-fmt..............................................................Passed
134+
shellcheck...............................................................Passed
135+
```
136+
137+
to run all the code quality tooling specified in the [pre-commit-check config file](pre-commit-check.nix).
138+
These `pre-commit` checks need to pass for a `git commit` to be successful.
113139

114140
### Tutorial
115141

flake.lock

Lines changed: 10 additions & 11 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

flake.nix

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
# Plutip maintains a compatible Plutus/Cardano derivation set
66
bot-plutus-interface.url = "github:mlabs-haskell/bot-plutus-interface";
77

8-
plutip.url = "github:mlabs-haskell/plutip/bladyjoker/upgrade-to-sam-vasil";
8+
plutip.url = "github:mlabs-haskell/plutip";
99
plutip.inputs.bot-plutus-interface.follows = "bot-plutus-interface";
1010
plutip.inputs.haskell-nix.follows = "bot-plutus-interface/haskell-nix";
1111
plutip.inputs.iohk-nix.follows = "bot-plutus-interface/iohk-nix";
@@ -14,11 +14,7 @@
1414
nixpkgs.follows = "plutip/nixpkgs";
1515
haskell-nix.follows = "plutip/haskell-nix";
1616

17-
18-
flake-utils = {
19-
url = "github:numtide/flake-utils";
20-
inputs.nixpkgs.follows = "haskell-nix/nixpkgs";
21-
};
17+
flake-utils.url = "github:numtide/flake-utils";
2218

2319
pre-commit-hooks.url = "github:cachix/pre-commit-hooks.nix";
2420

0 commit comments

Comments
 (0)