@@ -2,41 +2,43 @@ aw-server-rust
22==============
33
44[ ![ Dependency Status] ( https://deps.rs/repo/github/activitywatch/aw-server-rust/status.svg )] ( https://deps.rs/repo/github/activitywatch/aw-server-rust )
5- [ ![ Build Status] ( https://travis-ci.org/ActivityWatch/aw-server-rust.svg?branch=master )] ( https://travis-ci.org/ActivityWatch/aw-server-rust )
6- [ ![ Coverage Status] ( https://codecov.io/gh/ActivityWatch/aw-server-rust/branch/master/graph/badge.svg )] ( https://codecov.io/gh/ActivityWatch/aw-server-rust )
5+ ![ Build Status] ( https://github.com/ActivityWatch/aw-server-rust/workflows/Rust/badge.svg )
76
8- A reimplementation of aw-server in Rust
7+ [ ![ Coverage Status ] ( https://codecov.io/gh/ActivityWatch/ aw-server-rust/branch/master/graph/badge.svg )] ( https://codecov.io/gh/ActivityWatch/aw-server-rust )
98
10- Primary features missing:
11- - None?
9+ A reimplementation of aw-server in Rust.
1210
1311Caveats:
14- - Lots of TODO and FIXME comments
1512
16- Bugs:
17- - Memory leak during Bucket import? (wtf rust?)
13+ - Lots of TODO and FIXME comments
14+
15+ Features missing compared to the Python implementation of aw-server:
1816
19- Features missing compared to aw-server python:
20- - Swagger support
17+ - API explorer (Swagger/OpenAPI)
2118
2219### How to compile
2320
24- Install rust nightly with rustup
21+ Install rust nightly with ` rustup ` :
2522
26- ``` rustup default nightly ```
23+ ```
24+ rustup default nightly
25+ ```
2726
28- Run cargo build to build
27+ Build with ` cargo ` :
2928
30- ``` cargo build --release ```
29+ ```
30+ cargo build --release
31+ ```
3132
32- ### How to run
33+ Your built executable will be located in ` ./target/release/aw-server-rust `
3334
34- After compilation you will have an executable at target/release/aw-server-rust
3535
36- ``` ./target/release/aw-server-rust ```
36+ ### How to run
3737
38- If you want to quick-compile for debugging, run cargo run from the project root
38+ If you want to quick-compile for debugging, run cargo run from the project root:
3939
40- * NOTE:* this will start aw-server-rust on the testing port 5666 instead of port 5600
40+ ```
41+ cargo run --bin aw-server
42+ ```
4143
42- ``` cargo run ```
44+ * NOTE: * This will start aw-server-rust in testing mode (on port 5666 instead of port 5600).
0 commit comments