From 17bd337726246ab2c6647dcd6034cdf4b83a521c Mon Sep 17 00:00:00 2001 From: sloum Date: Sun, 23 May 2021 22:34:01 -0700 Subject: [PATCH] Adds license and super basic readme --- LICENSE | 7 +++++++ README.md | 5 +++++ main.go | 9 +++++++++ 3 files changed, 21 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..b39593a --- /dev/null +++ b/LICENSE @@ -0,0 +1,7 @@ +Copyright © 2021 sloum < sloum@rawtext.club > + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..7b0c81f --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +# nums + +This is a basic cli calculator that uses postfix notation and can accept piped data. To use data from a command line pipe use the `-p` flag, for example: `echo "2 2 +" | nums -p`. The example would output `4`, but without the `-p` flag would produce a runtime panic. + +For help/available operators enter `?` or `help` at the repl or via piped data to get help information printed to stderr. diff --git a/main.go b/main.go index 644eab7..e901443 100644 --- a/main.go +++ b/main.go @@ -1,3 +1,12 @@ +// nums, a postfix cli calculator +// +// Copyright © 2021 sloum < sloum@rawtext.club > +// +// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. package main import (