Skip to content

Commit

Permalink
Merge pull request #4949 from input-output-hk/newhoggy/fix-path-to-mk…
Browse files Browse the repository at this point in the history
…files.sh

Fix path to mkfiles.sh script in documentation
  • Loading branch information
newhoggy authored Mar 8, 2023
2 parents 9a24ace + 44a3d8c commit 3764e26
Showing 1 changed file with 7 additions and 12 deletions.
19 changes: 7 additions & 12 deletions scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
The `scripts` directory consists of the following directories:
- [benchmarking](#benchmarking)
- [buildkite](#buildkite)
- [byron-shelley-allegra-mary](#byron-shelley-allegra-mary)
- [lite](#lite)
- [shelley-from-scratch](#shelley-from-scratch)
- [byron-to-alonzo](#byron-to-alonzo)
Expand All @@ -12,14 +11,6 @@ The `scripts` directory consists of the following directories:
#### buildkite
Contains scripts relevant to IOHK's CI.

#### byron-shelley-allegra-mary
Contains a script that sets up a cluster beginning in the Byron era and can transition to the Shelley era. You can also start a cluster in the Shelley, Allegra or Mary era by supplying an argument to `mk-files.sh`.
E.g
```bash
./scripts/byron-to-mary/mk-files.sh shelley # Starts nodes in Shelley era
./scripts/byron-to-mary/mk-files.sh allegra # Starts nodes in Allegra era
./scripts/byron-to-mary/mk-files.sh mary # Starts nodes in Mary era
```
#### lite
Contains scripts that can start various clusters and intended to be as simple as possible. Note that using the shelley only era testnet clusters breaks compatibility with some cli commands.

Expand All @@ -28,18 +19,22 @@ Contains a script that creates all the necessary keys etc to create a shelley cl

#### byron-to-alonzo
Contains a script that creates all the necessary keys and configuration files to create an alonzo cluster from scratch.
This script is similar to [byron-shelley-allegra-mary](#byron-shelley-allegra-mary) script: It can either be used to start cluster in Byron and then gradually transition to Alonzo, or can jumpstart straight into selected era, eg.:
```

It can either be used to start cluster in Byron and then gradually transition to Alonzo, or can jumpstart straight into selected era, eg.:

```bash
./scripts/byron-to-alonzo/mkfiles.sh alonzo
```

will start the cluster in Alonzo era from epoch 0.

#### plutus

Contains scripts to test submission of transactions containing (simple) Plutus scripts. Obviously, only works against a test cluster running in Alonzo era.

Example:
```

```bash
$ scripts/plutus/example-txin-locking-plutus-script.sh guessinggame
```
will post several transactions validating against the simple guessing Game plutus contract.

0 comments on commit 3764e26

Please sign in to comment.