From b073ba1ef717aabb60744bdf1afbd0ee4444a912 Mon Sep 17 00:00:00 2001 From: Alex van de Sandt Date: Tue, 7 Jul 2026 16:32:00 -0500 Subject: [PATCH] Clean up readmes, emails, and repo links --- Cargo.toml | 4 ++-- README.md | 2 +- candid_client/Cargo.toml | 1 - candid_client/{README => README.md} | 12 ------------ candid_client/examples/echo.rs | 2 +- candid_client/examples/send.rs | 2 +- candid_server/Cargo.toml | 1 - candid_server/{README => README.md} | 13 ------------- candid_server/src/main.rs | 2 +- 9 files changed, 6 insertions(+), 33 deletions(-) rename candid_client/{README => README.md} (75%) rename candid_server/{README => README.md} (79%) diff --git a/Cargo.toml b/Cargo.toml index f9442fe..cee683d 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -5,10 +5,10 @@ members = [ ] [workspace.package] -authors = ["Alex van de Sandt "] +authors = ["Alex van de Sandt "] edition = "2018" license = "MIT" -repository = "https://gitlab.com/avandesa/candid-rs" +repository = "https://tangled.org/igneousflock.dev/candid-rs" keywords = ["CAN", "SocketCAN"] [workspace.dependencies] diff --git a/README.md b/README.md index fc8c887..ffe9073 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,4 @@ A client and server for reading, parsing, and relaying messages from a Controller Area Network bus across a network. -Author: [Alex van de Sandt](https://avandesa.github.io) (avandesa@purdue.edu) +Author: [Alex van de Sandt](https://tangled.org/igneousflock.dev) (me@alexvds.com) diff --git a/candid_client/Cargo.toml b/candid_client/Cargo.toml index 776d987..6166c71 100644 --- a/candid_client/Cargo.toml +++ b/candid_client/Cargo.toml @@ -3,7 +3,6 @@ name = "candid_client" version = "0.3.2" description = "A library to handle client connections to a CANdid server" readme = "README" -documentation = "https://docs.rs/crate/candid_client/" authors.workspace = true edition.workspace = true diff --git a/candid_client/README b/candid_client/README.md similarity index 75% rename from candid_client/README rename to candid_client/README.md index 50c4290..ab95139 100644 --- a/candid_client/README +++ b/candid_client/README.md @@ -4,10 +4,6 @@ A library for handling connections to a [CANdid server](https://crates.io/crates a TCP connection. The CandidConnection struct can both read and write frames to the server, which are then written to the bus by candid_server. -Repository: https://gitlab.com/avandesa/candid-rs - -Documentation: https://docs.rs/crates/candid_client/ - ## Getting Started ### Prerequisites @@ -24,14 +20,6 @@ The example `send` uses [`rand`](https://crates.io/crates/rand) to generate rand * `echo`: Print all frames to `stdout` * `send`: Send 10 random frames, then start printing all frames to `stdout`. The sent frames should be displayed as well -## Versioning -We use [SemVer](http://semver.org/) for versioning. For the versions available, see the -[tags on this repository](https://gitlab.com/avandesa/candid-rs/tags). - -## Authors - -* **Alex van de Sandt** - [avandesa](https://gitlab.com/avandesa) - ## License This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. diff --git a/candid_client/examples/echo.rs b/candid_client/examples/echo.rs index 67700e6..c6d8aad 100644 --- a/candid_client/examples/echo.rs +++ b/candid_client/examples/echo.rs @@ -5,7 +5,7 @@ use clap::{App, Arg}; fn main() { let matches = App::new("CANdid Client") .version("0.1.0") - .author("Alex van de Sandt ") + .author("Alex van de Sandt ") .about("A client to read messages from a CANdid server") .arg( Arg::with_name("addr") diff --git a/candid_client/examples/send.rs b/candid_client/examples/send.rs index ac43cca..306d88d 100644 --- a/candid_client/examples/send.rs +++ b/candid_client/examples/send.rs @@ -7,7 +7,7 @@ use clap::{App, Arg}; fn main() { let matches = App::new("CANdid Client") .version("0.1.0") - .author("Alex van de Sandt ") + .author("Alex van de Sandt ") .about("A client to send messages to a CANdid server") .arg( Arg::with_name("addr") diff --git a/candid_server/Cargo.toml b/candid_server/Cargo.toml index 0d53fa7..6bf9130 100644 --- a/candid_server/Cargo.toml +++ b/candid_server/Cargo.toml @@ -3,7 +3,6 @@ name = "candid_server" version = "0.3.0" description = "A server for reading and relaying messages on a CAN bus" readme = "README" -documentation = "https://docs.rs/crate/candid_server/" authors.workspace = true edition.workspace = true diff --git a/candid_server/README b/candid_server/README.md similarity index 79% rename from candid_server/README rename to candid_server/README.md index 6bf9a2d..59aa1fa 100644 --- a/candid_server/README +++ b/candid_server/README.md @@ -4,10 +4,6 @@ A server that faciliates connections between remote TCP clients and a local CAN sent frames read off the bus, and may send frames back to the server that are then written to the bus. -Repository: https://gitlab.com/avandesa/candid-rs - -Documentation: https://docs.rs/crate/candid_server/ - ## Getting Started ### Prerequisites @@ -40,15 +36,6 @@ frames. * [clap](https://crates.io/crates/clap) - For command line argument parsing. * [byteorder](https://crates.io/crates/byteorder) - For writing frames -## Versioning - -We use [SemVer](http://semver.org/) for versioning. For the versions available, see the -[tags on this repository](https://gitlab.com/avandesa/candid-rs/tags). - -## Authors - -* **Alex van de Sandt** - [avandesa](https://gitlab.com/avandesa) - ## License This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details diff --git a/candid_server/src/main.rs b/candid_server/src/main.rs index fb9464e..08f80de 100644 --- a/candid_server/src/main.rs +++ b/candid_server/src/main.rs @@ -30,7 +30,7 @@ use clap::{App, Arg}; fn main() { let matches = App::new("CANdid Server") .version("0.1.0") - .author("Alex van de Sandt ") + .author("Alex van de Sandt ") .about("A server to read, parse, and relay messages from a CAN bus.") .arg( Arg::with_name("addr") -- 2.51.2