Skip to content

Commit 76347c5

Browse files
committed
Add simple Makefile & Readme to the new mithril-client crate
1 parent 3148bf4 commit 76347c5

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

mithril-client/Makefile

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
%:
2+
@:
3+
4+
.PHONY: all build test check clean doc
5+
6+
args = `arg="$(filter-out $@,$(MAKECMDGOALS))" && echo $${arg:-${1}}`
7+
8+
CARGO = cargo
9+
10+
all: test build
11+
12+
build:
13+
# We use 'portable' feature to avoid SIGILL crashes
14+
${CARGO} build --release --features portable
15+
16+
test:
17+
${CARGO} test
18+
19+
check:
20+
${CARGO} check --release --all-features --all-targets
21+
${CARGO} clippy --release --all-features --all-targets
22+
${CARGO} fmt --check
23+
24+
clean:
25+
${CARGO} clean
26+
27+
doc:
28+
${CARGO} doc --no-deps --open

mithril-client/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Mithril Client
2+
3+
## Documentation
4+
:rocket: The documentation is available at [`Mithril client library`](https://mithril.network/doc/next/manual/developer-docs/nodes/mithril-client-library) with Mithril
5+
6+
:bulb: A guide on how to [`Bootstrap a Cardano Node`](https://mithril.network/doc/manual/getting-started/bootstrap-cardano-node) with Mithril

0 commit comments

Comments
 (0)