style: convert to nextest; README.md formatting
This commit is contained in:
1 parent
88da4a2452
commit
0c1484c222
2 files changed
+28
-26
No files matched your search
+5
-4
@@ -4,6 +4,7 @@ packages:
|
|||||||
- cargo-audit
|
- cargo-audit
|
||||||
- cargo-deny
|
- cargo-deny
|
||||||
- cargo-msrv
|
- cargo-msrv
|
||||||
|
- cargo-nextest
|
||||||
- cargo-outdated
|
- cargo-outdated
|
||||||
- cargo-tarpaulin
|
- cargo-tarpaulin
|
||||||
- cargo-udeps
|
- cargo-udeps
|
||||||
@@ -52,13 +53,13 @@ tasks:
|
|||||||
rustup default stable
|
rustup default stable
|
||||||
cd vivaldi-nc/
|
cd vivaldi-nc/
|
||||||
cargo build --verbose --all-targets --all-features
|
cargo build --verbose --all-targets --all-features
|
||||||
cargo test --verbose --all-features
|
cargo nextest run --verbose --all-targets --all-features
|
||||||
- nightly: |
|
- nightly: |
|
||||||
rustup default nightly
|
rustup default nightly
|
||||||
cd vivaldi-nc/
|
cd vivaldi-nc/
|
||||||
cargo clippy --verbose --all-targets --all-features ||:
|
cargo clippy --verbose --all-targets --all-features ||:
|
||||||
cargo build --verbose --all-targets --all-features ||:
|
cargo build --verbose --all-targets --all-features ||:
|
||||||
cargo test --verbose --all-targets --all-features ||:
|
cargo nextest --verbose --all-targets --all-features ||:
|
||||||
- bench: |
|
- bench: |
|
||||||
rustup default stable
|
rustup default stable
|
||||||
cd vivaldi-nc/
|
cd vivaldi-nc/
|
||||||
|
|||||||
@@ -3,18 +3,19 @@
|
|||||||
 [](https://docs.rs/vivaldi-nc/) [](https://builds.sr.ht/~swaits/vivaldi-nc?) [](https://crates.io/crates/vivaldi-nc)  
|
 [](https://docs.rs/vivaldi-nc/) [](https://builds.sr.ht/~swaits/vivaldi-nc?) [](https://crates.io/crates/vivaldi-nc)  
|
||||||
|
|
||||||
<!--toc:start-->
|
<!--toc:start-->
|
||||||
- [Introduction](#introduction)
|
- [vivaldi-nc - Vivaldi Network Coordinates](#vivaldi-nc-vivaldi-network-coordinates)
|
||||||
- [Addressing the Drawbacks](#addressing-the-drawbacks)
|
- [Introduction](#introduction)
|
||||||
- [Usage](#usage)
|
- [Addressing the Drawbacks](#addressing-the-drawbacks)
|
||||||
- [Getting Started](#getting-started)
|
- [Usage](#usage)
|
||||||
- [Cargo Features](#cargo-features)
|
- [Getting Started](#getting-started)
|
||||||
- [Examples](#examples)
|
- [Cargo Features](#cargo-features)
|
||||||
- [Dependencies](#dependencies)
|
- [Examples](#examples)
|
||||||
- [Design Goals & Alternatives](#design-goals-alternatives)
|
- [Dependencies](#dependencies)
|
||||||
- [Other Vivaldi NC Implementations](#other-vivaldi-nc-implementations)
|
- [Design Goals & Alternatives](#design-goals-alternatives)
|
||||||
- [Other NC Algorithms](#other-nc-algorithms)
|
- [Other Vivaldi NC Implementations](#other-vivaldi-nc-implementations)
|
||||||
- [Getting Help or Contributing](#getting-help-or-contributing)
|
- [Other NC Algorithms](#other-nc-algorithms)
|
||||||
- [License](#license)
|
- [Getting Help or Contributing](#getting-help-or-contributing)
|
||||||
|
- [License](#license)
|
||||||
<!--toc:end-->
|
<!--toc:end-->
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
@@ -37,20 +38,20 @@ According to the [Vivaldi coordinates article on Wikipedia](https://en.wikipedia
|
|||||||
> has a prime use in networking. The algorithm behind the system uses a
|
> has a prime use in networking. The algorithm behind the system uses a
|
||||||
> distributed technique to estimate propagation times between peers in the
|
> distributed technique to estimate propagation times between peers in the
|
||||||
> network.
|
> network.
|
||||||
>
|
>
|
||||||
> Through this scheme, network topology awareness can be used to tune the
|
> Through this scheme, network topology awareness can be used to tune the
|
||||||
> network behaviour to more efficiently distribute data. For example, in a
|
> network behaviour to more efficiently distribute data. For example, in a
|
||||||
> peer-to-peer network, more responsive identification and delivery of content
|
> peer-to-peer network, more responsive identification and delivery of content
|
||||||
> can be achieved. In the Azureus application, Vivaldi is used to improve the
|
> can be achieved. In the Azureus application, Vivaldi is used to improve the
|
||||||
> performance of the distributed hash table that facilitates query matches.
|
> performance of the distributed hash table that facilitates query matches.
|
||||||
>
|
>
|
||||||
> **Advantages**
|
> **Advantages**
|
||||||
>
|
>
|
||||||
> - Vivaldi is a fully distributed scheme, which achieves good scalability.
|
> - Vivaldi is a fully distributed scheme, which achieves good scalability.
|
||||||
> - The Vivaldi algorithm is simple and easy to implement.
|
> - The Vivaldi algorithm is simple and easy to implement.
|
||||||
>
|
>
|
||||||
> **Drawbacks**
|
> **Drawbacks**
|
||||||
>
|
>
|
||||||
> - Vivaldi is based on the Euclidean distance model, which requires the
|
> - Vivaldi is based on the Euclidean distance model, which requires the
|
||||||
> predicted distances to obey the triangle inequality. However, there are
|
> predicted distances to obey the triangle inequality. However, there are
|
||||||
> many triangle inequality violations (TIVs) on the Internet.
|
> many triangle inequality violations (TIVs) on the Internet.
|
||||||
@@ -278,19 +279,19 @@ the MIT license.
|
|||||||
## License
|
## License
|
||||||
|
|
||||||
> MIT License
|
> MIT License
|
||||||
>
|
>
|
||||||
> Copyright (c) 2023 Stephen Waits
|
> Copyright (c) 2023 Stephen Waits
|
||||||
>
|
>
|
||||||
> Permission is hereby granted, free of charge, to any person obtaining a copy
|
> Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
> of this software and associated documentation files (the "Software"), to deal
|
> of this software and associated documentation files (the "Software"), to deal
|
||||||
> in the Software without restriction, including without limitation the rights
|
> in the Software without restriction, including without limitation the rights
|
||||||
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
> copies of the Software, and to permit persons to whom the Software is
|
> copies of the Software, and to permit persons to whom the Software is
|
||||||
> furnished to do so, subject to the following conditions:
|
> furnished to do so, subject to the following conditions:
|
||||||
>
|
>
|
||||||
> The above copyright notice and this permission notice shall be included in all
|
> The above copyright notice and this permission notice shall be included in all
|
||||||
> copies or substantial portions of the Software.
|
> copies or substantial portions of the Software.
|
||||||
>
|
>
|
||||||
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
|||||||
Reference in new issue
Block a user