Skip to content

Commit 1c8a710

Browse files
authored
Stop using cargo rdme to generate README files in examples (#3112)
## Motivation This complicates things. Also `lib.rs` is not even the main file of the applications. ## Proposal * Stop using `cargo rdme` to generate README files in examples * Deactivate the correspondign test in CI * Fix the title depths for github markdown ## Test Plan * CI * check rendering of markdown in the github branch
1 parent f74b6ae commit 1c8a710

File tree

25 files changed

+83
-2261
lines changed

25 files changed

+83
-2261
lines changed

.github/workflows/rust.yml

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -332,13 +332,6 @@ jobs:
332332
- name: Check for outdated README.md
333333
run: |
334334
(set -e; for I in linera-*; do if [ -d "$I" ]; then echo $I; cargo rdme --check --no-fail-on-warnings -w $I; fi; done)
335-
(set -e; cd examples; for dir in */; do
336-
if [ -f "${dir}README.md" ] && grep -q "<!-- cargo-rdme start -->" "${dir}README.md"; then
337-
dir_name="${dir%/}"
338-
echo "${dir_name}"
339-
cargo rdme --check --no-fail-on-warnings -w "${dir_name}"
340-
fi
341-
done)
342335
343336
lint-wasm-applications:
344337
runs-on: ubuntu-latest

examples/amm/README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
<!-- cargo-rdme start -->
2-
31
# Automated Market Maker (AMM) Example Application
42

53
This example implements an Automated Market Maker (AMM) which demonstrates DeFi capabilities of the
64
Linera protocol. Prerequisite for the AMM application is the `fungible` application, as we will
75
be adding/removing liquidity and also performing a swap.
86

9-
# How it works
7+
## How it works
108

119
It supports the following operations. All operations need to be executed remotely.
1210

@@ -25,9 +23,9 @@ It supports the following operations. All operations need to be executed remotel
2523
the amounts from both tokens as a removal of liquidity. The owner, in this context, is the user
2624
removing liquidity, which currently can only be a chain owner.
2725

28-
# Usage
26+
## Usage
2927

30-
## Setting Up
28+
### Setting Up
3129

3230
Before getting started, make sure that the binary tools `linera*` corresponding to
3331
your version of `linera-sdk` are in your PATH. For scripting purposes, we also assume
@@ -86,7 +84,7 @@ AMM_APPLICATION_ID=$(linera --wait-for-outgoing-messages \
8684
--required-application-ids $FUN1_APP_ID $FUN2_APP_ID)
8785
```
8886

89-
## Using the AMM Application
87+
### Using the AMM Application
9088

9189
First, a node service for the current wallet has to be started:
9290

@@ -95,7 +93,7 @@ PORT=8080
9593
linera service --port $PORT &
9694
```
9795

98-
### Using GraphiQL
96+
#### Using GraphiQL
9997

10098
Type each of these in the GraphiQL interface and substitute the env variables with their actual
10199
values that we've defined above.
@@ -246,7 +244,7 @@ mutation {
246244
}
247245
```
248246

249-
### Atomic Swaps
247+
#### Atomic Swaps
250248

251249
In general, if you send tokens to a chain owned by someone else, you rely on them
252250
for asset availability: If they don't handle your messages, you don't have access to
@@ -323,5 +321,3 @@ query {
323321
}
324322
}
325323
```
326-
327-
<!-- cargo-rdme end -->

0 commit comments

Comments
 (0)