Skip to content

Commit 4a1943a

Browse files
committed
docs: improved aw-server and aw-sync READMEs
1 parent 26a7e04 commit 4a1943a

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ Features missing compared to the Python implementation of aw-server:
1919

2020
Install rust nightly with `rustup`:
2121

22-
```
22+
```sh
2323
rustup default nightly
2424
```
2525

2626
Build with `cargo`:
2727

28-
```
28+
```sh
2929
cargo build --release
3030
```
3131

@@ -36,8 +36,12 @@ Your built executable will be located in `./target/release/aw-server-rust`
3636

3737
If you want to quick-compile for debugging, run cargo run from the project root:
3838

39-
```
39+
```sh
4040
cargo run --bin aw-server
4141
```
4242

4343
*NOTE:* This will start aw-server-rust in testing mode (on port 5666 instead of port 5600).
44+
45+
### Syncing
46+
47+
For details about aw-sync-rust, see the [README](./aw-sync/README.md) in its subdirectory.

aw-sync/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@ cargo run --bin aw-server -- --testing --port $PORT --dbpath test-$PORT.sqlite -
2323

2424
You can create some test data by opening `http://localhost:5667/#/stopwatch` and creating a few events.
2525

26-
Then run `cargo run --bin aw-sync-rust` to sync your instance's buckets with the target directory.
26+
Then run `cargo run --bin aw-sync-rust -- --port 5667` to sync your instance's buckets with the target directory.
2727

2828
### Pulling from the sync directory
2929

3030
Now to sync things back from the sync directory onto another instance. First, lets start another instance:
3131

32-
```
32+
```sh
3333
PORT=5668
3434
cargo run --bin aw-server -- --testing --port $PORT --dbpath test-$PORT.sqlite --device-id $PORT --no-legacy-import
3535
```
3636

37-
Now run `aw-sync-rust` again.
37+
Now run `cargo run --bin aw-sync-rust -- --port 5668` to pull buckets from the sync dir (retrieving events from the 5667 instance) and push buckets from the 5668 instance to the sync dir.

0 commit comments

Comments
 (0)