summaryrefslogtreecommitdiff
path: root/benoit-cli
diff options
context:
space:
mode:
Diffstat (limited to 'benoit-cli')
-rw-r--r--benoit-cli/Cargo.toml10
-rw-r--r--benoit-cli/README.md23
2 files changed, 28 insertions, 5 deletions
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/>.