generated from rust-vmm/crate-template
-
Notifications
You must be signed in to change notification settings - Fork 60
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This is going to be eventually published to crates.io. This is the crate that we're using for upstreaming building blocks for setting up the vm and vcpu for booting. For now it lives in vmm-reference, but we are considering moving it to its own worspace at some point in time. Signed-off-by: Andreea Florescu <[email protected]>
- Loading branch information
1 parent
84a37bc
commit 92e08c5
Showing
3 changed files
with
60 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,12 @@ | ||
[package] | ||
name = "vm-vcpu-ref" | ||
version = "0.1.0" | ||
authors = ["rust-vmm AWS maintainers <[email protected]>"] | ||
edition = "2018" | ||
description = "Wrappers for setting up a VM for booting" | ||
repository = "https://github.com/rust-vmm/vmm-reference" | ||
readme = "README.md" | ||
license = "Apache-2.0 OR BSD-3-Clause" | ||
keywords = ["virt", "kvm", "vm"] | ||
|
||
[dependencies] |
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,41 @@ | ||
# Crate Name | ||
|
||
## Design | ||
|
||
TODO: This section should have a high-level design of the crate. | ||
|
||
Some questions that might help in writing this section: | ||
- What is the purpose of this crate? | ||
- What are the main components of the crate? How do they interact which each | ||
other? | ||
|
||
## Usage | ||
|
||
TODO: This section describes how the crate is used. | ||
|
||
Some questions that might help in writing this section: | ||
- What traits do users need to implement? | ||
- Does the crate have any default/optional features? What is each feature | ||
doing? | ||
- Is this crate used by other rust-vmm components? If yes, how? | ||
|
||
## Examples | ||
|
||
TODO: Usage examples. | ||
|
||
```rust | ||
use my_crate; | ||
|
||
... | ||
``` | ||
|
||
## License | ||
|
||
**!!!NOTICE**: The BSD-3-Clause license is not included in this template. | ||
The license needs to be manually added because the text of the license file | ||
also includes the copyright. The copyright can be different for different | ||
crates. If the crate contains code from CrosVM, the crate must add the | ||
CrosVM copyright which can be found | ||
[here](https://chromium.googlesource.com/chromiumos/platform/crosvm/+/master/LICENSE). | ||
For crates developed from scratch, the copyright is different and depends on | ||
the contributors. |
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,7 @@ | ||
#[cfg(test)] | ||
mod tests { | ||
#[test] | ||
fn it_works() { | ||
assert_eq!(2 + 2, 4); | ||
} | ||
} |