Compare commits
2 Commits
b6e90588fb
...
8757bc89f9
Author | SHA1 | Date |
---|---|---|
Bauke | 8757bc89f9 | |
Bauke | 6fbe1f9867 |
|
@ -1,17 +1,7 @@
|
||||||
# Generated by Cargo
|
# Generated by Cargo
|
||||||
# will have compiled files and executables
|
Cargo.lock
|
||||||
debug/
|
debug/
|
||||||
target/
|
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
|
# Code coverage results
|
||||||
.coverage
|
coverage/
|
||||||
|
|
10
Cargo.toml
10
Cargo.toml
|
@ -3,10 +3,10 @@
|
||||||
[package]
|
[package]
|
||||||
name = "romantic"
|
name = "romantic"
|
||||||
description = "Roman numeral toolkit"
|
description = "Roman numeral toolkit"
|
||||||
authors = ["Holllo <helllo@holllo.cc>"]
|
repository = "https://git.bauke.xyz/Holllo/romantic"
|
||||||
version = "0.1.0"
|
|
||||||
license = "MIT OR Apache-2.0"
|
license = "MIT OR Apache-2.0"
|
||||||
repository = "https://github.com/Holllo/romantic"
|
version = "0.1.1"
|
||||||
|
authors = ["Holllo <helllo@holllo.org>"]
|
||||||
edition = "2021"
|
edition = "2021"
|
||||||
|
|
||||||
[lib]
|
[lib]
|
||||||
|
@ -14,7 +14,7 @@ path = "source/lib.rs"
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
num = "0.4.0"
|
num = "0.4.0"
|
||||||
thiserror = "1.0.30"
|
thiserror = "1.0.36"
|
||||||
|
|
||||||
[dev-dependencies]
|
[dev-dependencies]
|
||||||
test-case = "2.0.2"
|
test-case = "2.2.1"
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
MIT License
|
MIT License
|
||||||
|
|
||||||
Copyright (c) 2022 Holllo <helllo@holllo.cc>
|
Copyright (c) 2022 Holllo <helllo@holllo.org>
|
||||||
|
|
||||||
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
|
||||||
|
|
|
@ -33,7 +33,7 @@ args = [
|
||||||
"tarpaulin",
|
"tarpaulin",
|
||||||
"--exclude-files=target/*",
|
"--exclude-files=target/*",
|
||||||
"--out=html",
|
"--out=html",
|
||||||
"--output-dir=.coverage",
|
"--output-dir=coverage",
|
||||||
"--skip-clean",
|
"--skip-clean",
|
||||||
"--target-dir=target/tarpaulin"
|
"--target-dir=target/tarpaulin"
|
||||||
]
|
]
|
||||||
|
|
18
README.md
18
README.md
|
@ -1,12 +1,10 @@
|
||||||
# Romantic
|
# Romantic 🏛
|
||||||
|
|
||||||
> Roman numeral toolkit
|
> **Roman numeral library for Rust.**
|
||||||
|
|
||||||
## API
|
## API
|
||||||
|
|
||||||
For full documentation see [docs.rs].
|
For full documentation see [docs.rs](https://docs.rs/romantic).
|
||||||
|
|
||||||
[docs.rs]: https://docs.rs/romantic
|
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
@ -20,7 +18,7 @@ let roman = Roman::default();
|
||||||
assert_eq!(roman.to_string(2022).unwrap(), "MMXXII");
|
assert_eq!(roman.to_string(2022).unwrap(), "MMXXII");
|
||||||
assert_eq!(roman.from_str::<i32>("MMXXII").unwrap(), 2022);
|
assert_eq!(roman.from_str::<i32>("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());
|
assert!(roman.to_string(4000).is_err());
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -42,8 +40,10 @@ assert_eq!(custom.from_str::<i32>("BA").unwrap(), 6);
|
||||||
assert!(custom.to_string(9).is_err());
|
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
|
## 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.
|
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.
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
Loading…
Reference in New Issue