Skip to content

Commit

Permalink
docs: updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
ErikBjare committed Mar 24, 2020
1 parent 3545fdd commit 62be9f4
Showing 1 changed file with 22 additions and 20 deletions.
42 changes: 22 additions & 20 deletions README.md
Expand Up @@ -2,41 +2,43 @@ aw-server-rust
==============

[![Dependency Status](https://deps.rs/repo/github/activitywatch/aw-server-rust/status.svg)](https://deps.rs/repo/github/activitywatch/aw-server-rust)
[![Build Status](https://travis-ci.org/ActivityWatch/aw-server-rust.svg?branch=master)](https://travis-ci.org/ActivityWatch/aw-server-rust)
[![Coverage Status](https://codecov.io/gh/ActivityWatch/aw-server-rust/branch/master/graph/badge.svg)](https://codecov.io/gh/ActivityWatch/aw-server-rust)
![Build Status](https://github.com/ActivityWatch/aw-server-rust/workflows/Rust/badge.svg)

A reimplementation of aw-server in Rust
[![Coverage Status](https://codecov.io/gh/ActivityWatch/aw-server-rust/branch/master/graph/badge.svg)](https://codecov.io/gh/ActivityWatch/aw-server-rust)

Primary features missing:
- None?
A reimplementation of aw-server in Rust.

Caveats:
- Lots of TODO and FIXME comments

Bugs:
- Memory leak during Bucket import? (wtf rust?)
- Lots of TODO and FIXME comments

Features missing compared to the Python implementation of aw-server:

Features missing compared to aw-server python:
- Swagger support
- API explorer (Swagger/OpenAPI)

### How to compile

Install rust nightly with rustup
Install rust nightly with `rustup`:

``` rustup default nightly ```
```
rustup default nightly
```

Run cargo build to build
Build with `cargo`:

``` cargo build --release ```
```
cargo build --release
```

### How to run
Your built executable will be located in `./target/release/aw-server-rust`

After compilation you will have an executable at target/release/aw-server-rust

``` ./target/release/aw-server-rust ```
### How to run

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

*NOTE:* this will start aw-server-rust on the testing port 5666 instead of port 5600
```
cargo run --bin aw-server
```

``` cargo run ```
*NOTE:* This will start aw-server-rust in testing mode (on port 5666 instead of port 5600).

0 comments on commit 62be9f4

Please sign in to comment.