From ccb2a830d30bff8d78211369dd21c488221b5310 Mon Sep 17 00:00:00 2001 From: Hiroshi Miura Date: Thu, 16 May 2024 23:07:42 +0900 Subject: [PATCH] docs: add README.md --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..0cbf51c --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# fork of jmyspell-core + +This repository is a forked jmyspell-core project used for OmegaT project. + +## Changes from original + +- Use UTF-8 for the code +- Use LF for line terminator character +- Migrate to a Gradle build system +- Fix several obvious bad coding styles + - constant ErrorInfo.MAX_SUGGESTIONS to be final + - constant Utils.XPRODUCT to be final + - remove redundant final from methods + - remove redundant public from interface + - use `isEmpty()` for condition that compare with zero length + - fix: define `Word#hashCode`, `Word` class already has `equals` definition + - fix: unwanted raw types +- style: apply spotbugs +- Quality assurance by checking with SpotBugs static code analysis +- CI: test with GitHub Actions +- Support Gradle develocity scan + +## License + +jmyspell-core is distributed under LGPL 2.1 \ No newline at end of file