diff options
Diffstat (limited to 'benoit-cli/README.md')
| -rw-r--r-- | benoit-cli/README.md | 23 |
1 files changed, 23 insertions, 0 deletions
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/>. |