fix: exclude examples from crate
crates.io is limited to 10MB crates Signed-off-by: Stephen Waits <steve@waits.net>
This commit is contained in:
2 files changed
+15
-4
No files matched your search
+4
-1
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "vivaldi-nc"
|
||||
version = "0.4.0"
|
||||
version = "0.4.1"
|
||||
edition = "2021"
|
||||
authors = ["Stephen Waits <steve@waits.net>"]
|
||||
description = "Vivaldi network coordinates with a simple interface."
|
||||
@@ -11,6 +11,9 @@ documentation = "https://docs.rs/vivaldi-nc/"
|
||||
readme = "README.md"
|
||||
homepage = "https://sr.ht/~swaits/vivaldi-nc/"
|
||||
repository = "https://git.sr.ht/~swaits/vivaldi-nc"
|
||||
exclude = [
|
||||
"examples/*",
|
||||
]
|
||||
|
||||
[dev-dependencies]
|
||||
assert_approx_eq = "1.1.0"
|
||||
|
||||
@@ -112,8 +112,9 @@ usage examples.
|
||||
|
||||
### Examples
|
||||
|
||||
Run an example which loads a n-to-n latency sample from PlanetLab and iterates
|
||||
on `NetworkCoordinate`s until some low-enough mean error is reached. The output is a JSON array of elements that look like this:
|
||||
The repository includes an example which loads a n-to-n latency sample from
|
||||
PlanetLab and iterates on `NetworkCoordinate`s until some low-enough mean error
|
||||
is reached. The output is a JSON array of elements that look like this:
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -131,9 +132,16 @@ on `NetworkCoordinate`s until some low-enough mean error is reached. The output
|
||||
},
|
||||
|
||||
```
|
||||
To run the example:
|
||||
To run the example, first clone the repository locally:
|
||||
|
||||
```bash
|
||||
git clone https://git.sr.ht/~swaits/vivaldi-nc
|
||||
```
|
||||
|
||||
Then `cd` into the local clone and run the example:
|
||||
|
||||
```bash
|
||||
cd vivaldi-nc
|
||||
cargo run --example planetlab
|
||||
```
|
||||
|
||||
|
||||
Reference in new issue
Block a user