diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 34ba3954..66e5c9af 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -7,11 +7,11 @@ assignees: ''
---
-**Describe the bug**
+## Bug Description
A clear and concise description of what the bug is.
If you are not sure whether it is a bug or not, please consider to open a Service request first.
-**To Reproduce**
+## How To Reproduce
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
@@ -19,15 +19,15 @@ Steps to reproduce the behavior:
4. Enter the command '...'
5. See error
-**Expected behavior**
+## Expected Behavior
A clear and concise description of what you expected to happen.
-**Screenshots**
+## Screenshots
If applicable, add screenshots to help explain your problem.
-**Environment (please complete the following information):**
+## Environment (please complete the following information)
Run `jacksum --info > env.txt` and attach env.txt.
Review env.txt before uploading. It may contain information that you don't wanna share (e.g. your user name on your desktop).
-**Additional context**
+## Additional Context
Add any other context about the problem here.
diff --git a/README.md b/README.md
index 9e79ea27..30f8f5b0 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,16 @@
-
+
-* * *
-
-
# Jacksum
+
+
**Jacksum** (**JAva ChecKSUM**) is a free, open source, cross-platform,
feature-rich, multi-threaded, command line utility that makes hash
functions available to you to solve particular tasks the smart way.
@@ -47,7 +46,7 @@ In order to achieve the goals above Jacksum supports you with
- Fully customizable output format
- 170+ different character sets to be able to read and write hash files
correctly
-- 9200+ lines of manpage with descriptions, examples, and compatibility
+- 9200+ lines of with descriptions, examples, and compatibility
lists for all supported algorithms
Jacksum is also a library. You can use it for your projects. It is written entirely in **Java** ☕.
@@ -79,7 +78,7 @@ Jacksum is for users with security in mind, advanced users, sysadmins, students
- Supported architectures are dependent on the OS and the JDK vendor:
- x86 64 bit (x64)
- x86 32 bit (x86)
- - ARM 64 bit (AArch64, resp. M1)
+ - ARM 64 bit (AArch64, resp. Apple silicon)
- ARM 32 bit (AArch32)
- PPC 64 bit (ppc64)
- a GitHub user have had success to run Jacksum without modification even on a smartphone running Android on ARM 64 bit, see also https://github.com/jonelo/jacksum/issues/7
@@ -106,25 +105,27 @@ Jacksum supports the **"Rocksoft (tm) Model CRC Algorithm"** to describe CRCs, s
## User Interfaces
-Jacksum provides a command line interface (CLI), and an application programming interface (API). A graphical user interface (GUI) is provided by HashGarten which is a subproject of the Jacksum project. Also, there are file browser integrations (FBI) available to integrate Jacksum and HashGarten into your preferred file browser such as Finder on macOS, Windows Explorer on Microsoft Windows or Caja, Dolphin, elementary Files, Konqueror, Krusader, Nemo, GNOME Nautilus, ROX-Filter, SpaceFM, Thunar, Xfe, or zzzFM on GNU/Linux.
+Jacksum provides a Command Line Interface (CLI), an Application Programming Interface (API). A Graphical User Interface (GUI) is provided by HashGarten which is a subproject of the Jacksum project. Also, there are File Browser Integrations (FBI) available.
+
+### Architecture
-### CLI
+
+
+### Command Line Interface (CLI)
If you are a skilled command line user you will benefit from the power on the command line and you can use Jacksum in scripts, cronjobs, etc. in order to automate file integration/verification tasks for example.
-### GUI
-
-If you prefer a graphical user interface (GUI) and you just would like to calc and verify hashes with a graphical user interface, I recommend to download and use the Jacksum File Browser Integration (FBI) installer which comes with [HashGarten](https://github.com/jonelo/HashGarten) that is a GUI for Jacksum. The installer is available for many different file managers on Windows, Linux, and macOS. See also [Integrations](https://github.com/jonelo/jacksum#integrations).
+See also the [manual of Jacksum](https://github.com/jonelo/jacksum/wiki/Manpage).
-
+### Graphical User Interface (GUI)
-
+If you prefer a GUI and you just would like to calc and verify hashes with a graphical user interface, I recommend to download and use the Jacksum File Browser Integration (FBI) installer which comes with [HashGarten](https://github.com/jonelo/HashGarten) that is a GUI for Jacksum. HashGarten also runs standalone and it supports Drag and Drop.
-## CLI usage
+### File Browser Integration (FBI)
-Go to (Jacksum's manual)[https://github.com/jonelo/jacksum/wiki/Manpage].
+The File Browser Integration (FBI) installer can integrate both Jacksum and HashGarten into your preferred file browser, such as Finder on macOS, Windows File Explorer on Microsoft Windows, and Caja, Dolphin, elementary Files, GNOME Nautilus, Konqueror, Krusader, muCommander, Nemo, ROX-Filter, SpaceFM, Thunar, Xfe, or zzzFM on GNU/Linux. See also [Integrations](https://github.com/jonelo/jacksum/tree/main?tab=readme-ov-file#integrations).
## Examples
@@ -652,9 +653,9 @@ $ rm -R jacksum-$VERSION/
## Integrations
-* [Jacksum File Browser Integration for Microsoft Windows](https://github.com/jonelo/jacksum-fbi-windows)
-* [Jacksum File Browser Integration for GNU/Linux](https://github.com/jonelo/jacksum-fbi-linux)
-* [Jacksum File Browser Integration for macOS](https://github.com/jonelo/jacksum-fbi-macos)
+* [Jacksum for Windows](https://github.com/jonelo/jacksum-for-windows)
+* [Jacksum for Linux](https://github.com/jonelo/jacksum-for-linux)
+* [Jacksum for macOS](https://github.com/jonelo/jacksum-for-macos)
* [Jacksum on Docker](https://hub.docker.com/r/jonelo/jacksum)
* [HashGarten](https://github.com/jonelo/HashGarten) - a GUI for Jacksum
* NumericalChameleon, see http://www.numericalchameleon.net