Skip to content

Commit 68d67bb

Browse files
committed
docs: update docs
1 parent 710738f commit 68d67bb

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

Makefile

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,17 @@ LEAN_SPEC_REPO_URL := https://github.com/leanEthereum/leanSpec
22
LEAN_SPEC_REPO_DIR := leanSpec
33

44
.PHONY: install test prod package tag release clean help
5+
.DEFAULT_GOAL := release
56

67
help:
78
@echo "Usage:"
9+
@echo " make - Alias for \`make release\`"
810
@echo " make install - Clone leanSpec repository"
911
@echo " make test - Generate keys for test scheme"
1012
@echo " make prod - Generate keys for prod scheme"
1113
@echo " make package - Create tar.gz archives from existing test_scheme/ and prod_scheme/ folders"
14+
@echo " make release - Run the entire workflow, from installing dependencies, key generation, to creating archives"
1215
@echo " make tag - Display leanSpec HEAD commit as leanSpec-<commit>, useful for tagging a release"
13-
@echo " make release - Generate keys (test & prod) and create tar.gz archives"
1416
@echo " make clean - Remove cloned leanSpec repository and release folder"
1517

1618
install:

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,24 @@
77
This repository provides a Makefile with commands to generate leanSig keys for different schemes, suitable for usage in [leanSpec](https://github.com/leanEthereum/leanSpec/) testing:
88

99
```bash
10+
make # Alias for `make release`
1011
make help # Display available commands
1112
make install # Clone leanSpec repository
1213
make test # Generate keys for test scheme
1314
make prod # Generate keys for prod scheme
14-
make release # Generate keys and create tar.gz archives (test_scheme.tar.gz, prod_scheme.tar.gz)
15+
make package # Create tar.gz archives from existing test_scheme/ and prod_scheme/ folders"
16+
make tag # Display leanSpec HEAD commit as leanSpec-<commit>, useful for tagging a release"
17+
make release # Run the entire workflow, from installing dependencies, key generation, to creating archives
1518
make clean # Remove cloned leanSpec repository and release folder
1619
```
1720

21+
## Quick start
22+
23+
Run the entire workflow, i.e. install dependencies, key generation, creating .tar.gz archives:
24+
```bash
25+
make
26+
```
27+
1828
## Examples
1929

2030
Generate test scheme keys:
@@ -31,9 +41,9 @@ make prod
3141

3242
## Preparing a release
3343

34-
Create release archives:
44+
Package the generated keys into release archives:
3545
```bash
36-
make release
46+
make package
3747
```
3848

3949
Use the output files (`.tar.gz` files) in [`release/`](./release/) folder to publish a new release.

0 commit comments

Comments
 (0)