-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
16c6160
commit 870229c
Showing
1 changed file
with
38 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# How to build the project | ||
|
||
## Docker | ||
|
||
Building with Docker is super easy. | ||
|
||
```shell | ||
docker build -f Dockerfile . -t name, organization, or whatever you like < your > /acars_router:test | ||
``` | ||
|
||
And the project should build with no issues. | ||
|
||
## Building acars_router from source | ||
|
||
If you desire to build `acars_router` from source, ensure you have [rust](https://www.rust-lang.org/tools/install) installed and up to date. `acars_router` build target is always the most recent Rust version, so you should not have to roll back to previous versions to get it built. | ||
|
||
Once you clone the repository and enter the repo's directory using a shell... | ||
|
||
Debugging: | ||
|
||
```shell | ||
cargo build | ||
``` | ||
|
||
Release | ||
|
||
```shell | ||
cargo build --release | ||
``` | ||
|
||
To run the project using cargo (useful for debugging): | ||
|
||
```shell | ||
|
||
cargo run -- <command line flags here> | ||
``` | ||
|
||
Or you can directly run/find the binary in the `target` directory. |