Skip to content

Commit 6d80a80

Browse files
authored
docs(misc): fix typo, add prep-iroha help message (#225)
1 parent 8a1ef6a commit 6d80a80

File tree

2 files changed

+23
-2
lines changed

2 files changed

+23
-2
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ deno task prep:iroha --path /path/to/local/iroha/clone
4444

4545
```sh
4646
# clone the repo
47-
deno task prep:iroha --git https://github.com/hyperledger-iroha/iroha.git --rev v2.0.0-rc.1.0
47+
deno task prep:iroha --git https://github.com/hyperledger-iroha/iroha.git --git-rev v2.0.0-rc.1.0
4848
```
4949

5050
After Iroha is linked, you need to prepare some artifacts from it (binaries such as `irohad`, `kagami`, `iroha_codec`;

etc/task-prep-iroha.ts

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,27 @@ await match(args)
131131
await copyArtifacts()
132132
})
133133
.otherwise(() => {
134-
$.logError('Bad CLI args')
134+
const cmd = colors.gray(`deno task prep:iroha`)
135+
136+
console.info(`Usage:
137+
138+
${colors.blue('## Link Iroha')}
139+
140+
${colors.magenta(`${cmd} --git <git repo> --git-rev <tag or revision>`)}
141+
to clone Iroha repo
142+
143+
or
144+
145+
${colors.magenta(`${cmd} --path <local path>`)}
146+
to symlink a local Iroha repo
147+
148+
${colors.blue('## Build')}
149+
150+
${colors.magenta(`${cmd} --build`)}
151+
to build Iroha artifacts
152+
153+
${colors.magenta(`${cmd} --check`)}
154+
to check that the artifacts are ready
155+
`)
135156
Deno.exit(1)
136157
})

0 commit comments

Comments
 (0)