Merge pull request #1 from wb8tyw/wb8tyw_152_153

Existing lzhuf from D-Rats

.codespellrc

@@ -0,0 +1,3 @@
+[codespell]
+skip = *./.git
+ignore-words-list = msdos

.github/workflows/codespell.yml

@@ -0,0 +1,16 @@
+---
+name: Codespell
+
+# Always run on Pull Requests
+on:  # yamllint disable-line rule:truthy
+  pull_request:
+
+jobs:
+  pylint:
+    name: Run Codespell
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Run check
+        uses: codespell-project/actions-codespell@master

.github/workflows/shellcheck.yml

@@ -0,0 +1,31 @@
+---
+name: ShellCheck
+
+# Always run on Pull Requests
+on:  # yamllint disable-line rule:truthy
+  pull_request:
+
+jobs:
+  pylint:
+    name: Run ShellCheck
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+      - name: Install core packages
+        run: |
+          ./tests/install_shellcheck_ubuntu.sh
+      - name: Pull via git
+        run: |
+          git fetch origin ${{ github.event.pull_request.base.sha }}
+      - name: Show git diff
+        run: |
+           git diff --name-only ${{ github.event.pull_request.base.sha }}
+      - name: Do the ShellCheck
+        run: |
+          base_sha="${{ github.event.pull_request.base.sha }}"
+          changed="$(git diff --name-only $base_sha)"
+          export CHANGED_FILES="$changed"
+          ./tests/pre-commit_d/shellcheck_check.sh

.github/workflows/yamllint.yml

@@ -0,0 +1,18 @@
+---
+name: Yamllint
+
+# Always run on Pull Requests
+on:  # yamllint disable-line rule:truthy
+  - pull_request
+
+jobs:
+  yamllint:
+    name: Run Yamllint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: 'Yamllint'
+        uses: karancode/yamllint-github-action@master
+        with:
+          yamllint_comment: false

COPYING

@@ -0,0 +1,68 @@
+# LZHUF General terms
+
+Use, distribute, and modify this program freely
+
+## Patents
+
+All known LZW patents world-wide have expired after 2004.
+
+## Historical reference
+
+<https://groups.google.com/g/comp.compression/c/u-YZjDzdF3A>
+
+Post by Russell Marks
+Aug 15, 2001, 5:31:54 AM
+
+Recently I posted asking about the authors/licence of `lzhuf.c'.
+I've contacted most of the authors since, so I thought I'd post the results.
+My main question to them was whether I could use lzhuf.c in a GPL'd program,
+but I did also try to clear up the original licence for those who might want
+to use it in BSD-licenced programs, or whatever.
+[1]
+
+Kenji Rikitake said, "my contribution to lzhuf.c is very little and I will not
+claim any objection for the usage".
+
+Haruhiko Okumura (or should I say, Professor Okumura :-)) said, initially
+referring to the "Permission granted for non-commercial use" comment that
+Kenji asked to be added in 1989, "I was unaware that Kenji had added that
+phrase.  I (and as far as I know, Yoshi) have never been that strict; LHarc
+and LHA have been included in many commercial software packages. There should
+be no problem if you take LZHUF.C as either GPL'd or LGPL'd."
+
+When I asked what licence I should say lzhuf.c was under, suggesting his old
+terms for (among others) lzari.c which are "Use, distribute, and modify this
+program freely", he agreed.
+
+Haruyasu Yoshizaki (Yoshi) has proven difficult to contact. I've emailed him
+at an address Prof. Okumura suggested might be worth trying, but from what
+I've read on the web about how busy he's said to be (and how he doesn't really
+want email, which explains why an email address for him was difficult to come
+by), I don't expect a reply.
+
+So, since lzhuf.c is significantly based on Okumura's lzari.c [2] (which has
+always had the above licence), I'm going to go with his opinion on the matter,
+and assume that Yoshi would not object. (Not least because Prof. Okumura said
+`I can assure you that his intention has always been "try it, and improve
+it."')
+
+In summary:
+
+The authors I've been able to contact agree to the licence "Use, distribute, and modify this program freely" - "freely" here meaning `without restriction',
+and not being a reference to price. The remaining author I've not been able to
+contact, but the licence appears consistent with his intent, and was also the
+licence on the original program which he modified (lzari.c).
+
+-Rus.
+
+[1] But note that LZH compression is unfortunately patented (US patent no.
+4,906,991 covers it) - decompression isn't, so I don't expect this to affect
+my program. And unless you have a specific need for LZH like I did, something
+like zlib would generally be a better choice anyway.
+
+[2] The version of lzhuf.c referred to by the `author' of the CP/M port made
+this rather clearer:
+
+* LZSS coded by Haruhiko OKUMURA
+* Adaptive Huffman Coding coded by Haruyasu YOSHIZAKI
+* Edited and translated to English by Kenji RIKITAKE

README.md

@@ -1,2 +1,57 @@
 # lzhuf
+
 C Implementation of lzhuf compression used with Winlink
+
+* LZSS coded by Haruhiko OKUMURA
+* Adaptive Huffman Coding coded by Haruyasu YOSHIZAKI
+* Edited and translated to English by Kenji RIKITAKE
+
+## Building And Testing
+
+### Tools needed
+
+#### Build packages
+
+* coreutils gcc make
+
+#### Testing packages
+
+* diffutils
+
+#### Github contributing packages
+
+* bash file git grep shellcheck codespell yamllint
+
+On some platforms use ShellCheck for the package name.
+
+### Building
+
+~~~text
+make clean
+make
+~~~
+
+### Testing
+
+On Windows, use lzhuf.exe instead of lzhuf.
+
+~~~text
+./lzhuf e tests/test_data.ref test_data.lzh
+diff test_data.lzh test_data.lzh_ref
+./lzhuf d test_data.lzh test_data.src
+diff test_data.src tests/test_data.ref
+
+## Deployment in Linux style directory tree
+
+On Windows, use lzhuf.exe instead of lzhuf.
+
+~~~text
+cp ./lzhuf /usr/local/bin/
+~~~
+
+### GitHub Pull requests
+
+#### Git commit hook installation
+
+cp tests/pre-commit .git/hooks
+chmod 755 .git/hooks/pre-commit