enarx-archive / sallyport

API for the hypervisor-microkernel boundary
Apache License 2.0
7 stars 6 forks source link

[Feature]: README needs a "Build" section #94

Closed greyspectrum closed 2 years ago

greyspectrum commented 2 years ago

Is there an existing issue for this?

Description

Currently, CI runs cargo test with these arguments:

cargo test --manifest-path src/v0.3/Cargo.toml --release

Running cargo test without these arguments will show that all tests passed (output below). There should be a brief note in the README to run cargo test with these arguments.

    Finished test [unoptimized + debuginfo] target(s) in 0.00s
     Running unittests (target/debug/deps/sallyport-dc9ffad34a52ce33)

running 11 tests
test tests::block_size ... ok
test tests::buf_capacity ... ok
test tests::msg_size ... ok
test tests::rep_size ... ok
test tests::req_size ... ok
test tests::request ... ok
test tests::copy_into_slice ... ok
test tests::cursor ... ok
test tests::copy_into_raw_parts ... ok
test tests::test_read_write ... ok
test tests::cursor_multiple_allocs ... ok

test result: ok. 11 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s

   Doc-tests sallyport

running 0 tests

test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s

Acceptance Criteria

No response

Suggestions for a technical implementation

No response