From e12dbad5e0be71e579692ab18a7ffacac153fcb4 Mon Sep 17 00:00:00 2001 From: Justin Worthe Date: Sun, 6 Jan 2019 08:15:47 +0200 Subject: Update of documentation --- LICENSE | 21 --------------------- example.qif | 16 ++++++++++++++++ license.org | 21 +++++++++++++++++++++ readme.org | 13 ++++++++++--- 4 files changed, 47 insertions(+), 24 deletions(-) delete mode 100644 LICENSE create mode 100644 example.qif create mode 100644 license.org diff --git a/LICENSE b/LICENSE deleted file mode 100644 index d3e83ae..0000000 --- a/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2018 Justin Worthe - -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/example.qif b/example.qif new file mode 100644 index 0000000..dc568a1 --- /dev/null +++ b/example.qif @@ -0,0 +1,16 @@ +!Type:Bank +D12/3/18 +T-336 +N +MC*KUNG-FU KITC123456 +^ +D12/11/18 +T0 +N +MCARRIED FORWARD +^ +D12/11/18 +T0 +N +MBROUGHT FORWARD +^ diff --git a/license.org b/license.org new file mode 100644 index 0000000..454f561 --- /dev/null +++ b/license.org @@ -0,0 +1,21 @@ +* MIT License + +Copyright (c) 2019 Justin Worthe + +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.org b/readme.org index 9631145..214e973 100644 --- a/readme.org +++ b/readme.org @@ -3,13 +3,16 @@ This small Rust program to preprocess QIF files that I get from my bank account. This mostly means normalizing the descriptions a bit, since my bank statement often does silly things like appending a -timestamp to the end. Also, different stores in the same franchise -sometimes use slightly different names. For example, I normalize "Kung -fu kitchen" and "Kungfu kitchen" to have the same description. +timestamp to the end and insert transactions with a value of 0. Also, +different stores in the same franchise sometimes use slightly +different names. For example, I normalize "Kung fu kitchen", "Kung-fu +kitchen" and "Kungfu kitchen" to have the same description. This is highly specialized for my own use, and isn't intended to be generally useful or configurable. +For an example of a qif file, look at [[./example.qif]] + * Usage #+BEGIN_EXAMPLE @@ -23,3 +26,7 @@ generally useful or configurable. ARGS: ... Files to preprocess #+END_EXAMPLE + +* License + +See [[./license.org]] -- cgit v1.2.3