diff options
-rw-r--r-- | CHANGELOG.md | 9 | ||||
-rw-r--r-- | Cargo.toml | 3 | ||||
-rw-r--r-- | README.md | 36 | ||||
-rw-r--r-- | benoit-cli/Cargo.toml | 10 | ||||
-rw-r--r-- | benoit-cli/README.md | 23 | ||||
-rw-r--r-- | benoit/Cargo.toml | 11 | ||||
-rw-r--r-- | benoit/README.md | 19 | ||||
-rw-r--r-- | benoit/src/lib.rs | 2 |
8 files changed, 65 insertions, 48 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 470441e..3eecf0c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,12 @@ +# 3.0.2 + +* Add per-crate readmes +* Bump dependencies + +## `benoit` + +* Remove `num-traits` as depedency + # 3.0.1 * Set Cargo metadata @@ -7,9 +7,8 @@ members = [ resolver = "2" [workspace.package] -version = "3.0.1" +version = "3.0.2" authors = ["Gabriel Bjørnager Jensen"] -readme = "README.md" homepage = "https://mandelbrot.dk/benoit" repository = "https://mandelbrot.dk/benoit" @@ -6,17 +6,6 @@ The project is structured around the main `benoit` library, of which front-ends The official front-ends currently include `benoit-cli` and `benoit-gui`, although the latter is currently not present in this repository. -# Usage - -``` -benoit-cli <path> -benoit-gui -``` - -The thread count may be specified using the environment variable `RAYON_NUM_THREADS`. - -See [Docs.rs](https://docs.rs/benoit/latest/benoit/) for documentation. - # Mirrors Benoit is officially hosted on the following mirrors: @@ -27,28 +16,7 @@ Benoit is officially hosted on the following mirrors: # Copyright & License -Also see individual files for their licenses. - -Note that the section *`benoit`* does **NOT** represent the entirety of the Benoit project, instead only the `benoit` library found in the `benoit` directory. +See the crates for their licenses. +Also see individual files for theirs. The contents of this readme are released under a Creative Commons Attribution-ShareAlike 4.0 International license, see <https://creativecommons.org/licenses/by-sa/4.0/> for more information. - -## `benoit` - -Copyright 2021, 2023-2024 Gabriel Bjørnager Jensen. - -This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. - -This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. - -You should have received a copy of the GNU Affero General Public License along with this program. If not, see <https://www.gnu.org/licenses/>. - -## `benoit-cli` and `benoit-gui` - -Copyright 2021, 2023-2024 Gabriel Bjørnager Jensen. - -This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. - -This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. - -You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>. diff --git a/benoit-cli/Cargo.toml b/benoit-cli/Cargo.toml index 7f00df2..df0ff5a 100644 --- a/benoit-cli/Cargo.toml +++ b/benoit-cli/Cargo.toml @@ -3,12 +3,12 @@ name = "benoit-cli" edition = "2021" license = "GPL-3.0-or-later" description = "Multithreaded Mandelbrot renderer, CLI front-end." +readme = "README.md" version.workspace = true authors.workspace = true homepage.workspace = true repository.workspace = true -readme.workspace = true [features] notify = ["notify-rust"] @@ -17,11 +17,11 @@ notify = ["notify-rust"] benoit = { path = "../benoit" } ctrlc = "3.4.4" -num-traits = "0.2.18" -rug = "1.24.0" -toml = "0.8.10" +num-traits = "0.2.19" +rug = "1.24.1" +toml = "0.8.13" -notify-rust = { version = "4.10.0", optional = true } +notify-rust = { version = "4.11.0", optional = true } [target.'cfg(windows)'.dependencies] windows = "0.54.0" diff --git a/benoit-cli/README.md b/benoit-cli/README.md new file mode 100644 index 0000000..2ee997d --- /dev/null +++ b/benoit-cli/README.md @@ -0,0 +1,23 @@ +# About + +The CLI front-end for the `benoit` library. + +# Usage + +``` +benoit-cli <path> +``` + +The thread count may be specified using the environment variable `RAYON_NUM_THREADS`. + +# Copyright & License + +*The contents of this readme are released under a Creative Commons Attribution-ShareAlike 4.0 International license, see <https://creativecommons.org/licenses/by-sa/4.0/> for more information.* + +Copyright 2021, 2023-2024 Gabriel Bjørnager Jensen. + +This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. + +This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. + +You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>. diff --git a/benoit/Cargo.toml b/benoit/Cargo.toml index 0b64505..4e2d14b 100644 --- a/benoit/Cargo.toml +++ b/benoit/Cargo.toml @@ -4,25 +4,24 @@ edition = "2021" license = "AGPL-3.0-or-later" description = "Multithreaded Mandelbrot renderer." documentation = "https://docs.rs/benoit" +readme = "README.md" version.workspace = true authors.workspace = true homepage.workspace = true repository.workspace = true -readme.workspace = true [features] wgpu-colour = ["wgpu"] [dependencies] -enum-iterator = "2.0.0" +enum-iterator = "2.1.0" lazy_static = "1.4.0" -num-traits = "0.2.18" png = "0.17.13" -rayon = "1.9.0" -rug = "1.24.0" +rayon = "1.10.0" +rug = "1.24.1" -wgpu = { version = "0.19.3", optional = true } +wgpu = { version = "0.20.0", optional = true } [lints] workspace = true diff --git a/benoit/README.md b/benoit/README.md new file mode 100644 index 0000000..1e5087a --- /dev/null +++ b/benoit/README.md @@ -0,0 +1,19 @@ +# About + +The core library of the [*Benoit*](https://mandelbrot.dk/benoit) project. + +The thread count used for rendering may be specified using the environment variable `RAYON_NUM_THREADS`. + +See [Docs.rs](https://docs.rs/benoit/latest/benoit/) for documentation. + +# Copyright & License + +*The contents of this readme are released under a Creative Commons Attribution-ShareAlike 4.0 International license, see <https://creativecommons.org/licenses/by-sa/4.0/> for more information.* + +Copyright 2021, 2023-2024 Gabriel Bjørnager Jensen. + +This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. + +This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. + +You should have received a copy of the GNU Affero General Public License along with this program. If not, see <https://www.gnu.org/licenses/>. diff --git a/benoit/src/lib.rs b/benoit/src/lib.rs index 4adc509..796e66c 100644 --- a/benoit/src/lib.rs +++ b/benoit/src/lib.rs @@ -46,7 +46,7 @@ pub mod stopwatch; /// The version number of benoit, currently being `3.0.0`. /// /// The version numbers of `benoit-cli` and `benoit-gui` match this value. -pub const VERSION: (u32, u32, u32) = (0x3, 0x0, 0x1); +pub const VERSION: (u32, u32, u32) = (0x3, 0x0, 0x2); /// The precision used for arbitrary precision computations, in bits. /// |