diff --git a/.gitignore b/.gitignore index 5a0faef..c31fef4 100644 --- a/.gitignore +++ b/.gitignore @@ -1,17 +1,7 @@ # Generated by Cargo -# will have compiled files and executables +Cargo.lock debug/ target/ -# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries -# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html -Cargo.lock - -# These are backup files generated by rustfmt -**/*.rs.bk - -# MSVC Windows builds of rustc generate these, which store debugging information -*.pdb - # Code coverage results -.coverage +coverage/ diff --git a/Cargo.toml b/Cargo.toml index c5a92c5..fc5a892 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,10 +3,10 @@ [package] name = "romantic" description = "Roman numeral toolkit" -authors = ["Holllo "] -version = "0.1.0" +repository = "https://git.bauke.xyz/Holllo/romantic" license = "MIT OR Apache-2.0" -repository = "https://github.com/Holllo/romantic" +version = "0.1.0" +authors = ["Holllo "] edition = "2021" [lib] @@ -14,7 +14,7 @@ path = "source/lib.rs" [dependencies] num = "0.4.0" -thiserror = "1.0.30" +thiserror = "1.0.36" [dev-dependencies] -test-case = "2.0.2" +test-case = "2.2.1" diff --git a/LICENSE-MIT b/LICENSE-MIT index 40a0b42..cacb2e3 100644 --- a/LICENSE-MIT +++ b/LICENSE-MIT @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2022 Holllo +Copyright (c) 2022 Holllo Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/Makefile.toml b/Makefile.toml index d68688b..d640ca1 100644 --- a/Makefile.toml +++ b/Makefile.toml @@ -33,7 +33,7 @@ args = [ "tarpaulin", "--exclude-files=target/*", "--out=html", - "--output-dir=.coverage", + "--output-dir=coverage", "--skip-clean", "--target-dir=target/tarpaulin" ] diff --git a/README.md b/README.md index 0ef9d12..98b6332 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,10 @@ -# Romantic +# Romantic 🏛 -> Roman numeral toolkit +> **Roman numeral library for Rust.** ## API -For full documentation see [docs.rs]. - -[docs.rs]: https://docs.rs/romantic +For full documentation see [docs.rs](https://docs.rs/romantic). ## Examples @@ -20,7 +18,7 @@ let roman = Roman::default(); assert_eq!(roman.to_string(2022).unwrap(), "MMXXII"); assert_eq!(roman.from_str::("MMXXII").unwrap(), 2022); -// The default Roman numeral has a maximum of 3999. +// The default Roman numeral system has a maximum of 3999. assert!(roman.to_string(4000).is_err()); ``` @@ -42,8 +40,10 @@ assert_eq!(custom.from_str::("BA").unwrap(), 6); assert!(custom.to_string(9).is_err()); ``` +## Feedback + +Found a problem or want to request a new feature? Email [helllo@holllo.org](mailto:helllo@holllo.org) and I'll see what I can do for you. + ## License -This project is licensed under either of [Apache License, Version 2.0](https://github.com/Holllo/romantic/blob/main/LICENSE-Apache) or [MIT license](https://github.com/Holllo/romantic/blob/main/LICENSE-MIT) at your option. - -Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. +Distributed under the [Apache License 2.0](https://spdx.org/licenses/Apache-2.0.html) and [MIT](https://spdx.org/licenses/MIT.html) licenses, see [LICENSE-Apache](https://git.bauke.xyz/Holllo/romantic/src/branch/main/LICENSE-Apache) and [LICENSE-MIT](https://git.bauke.xyz/Holllo/romantic/src/branch/main/LICENSE-MIT) for more information.