Skip to content

Commit b9b05eb

Browse files
authoredSep 5, 2023
Update README.md
1 parent afeece3 commit b9b05eb

File tree

1 file changed

+83
-23
lines changed

1 file changed

+83
-23
lines changed
 

‎README.md

+83-23
Original file line numberDiff line numberDiff line change
@@ -2,59 +2,119 @@
22

33
# Jacksum File Browser Integration on GNU/Linux
44

5-
The installer script installs Jacksum (https://github.com/jonelo/jacksum) and HashGarten (https://github.com/jonelo/HashGarten) which allows accessing Jacksum's primary features at the GNU/Linux File Browser's Script Menu.
5+
The installer script installs [Jacksum](https://github.com/jonelo/jacksum) and [HashGarten](https://github.com/jonelo/HashGarten) which allows accessing Jacksum's primary features at the GNU/Linux File Browser's script menu.
66

7-
## Requirements
7+
## System Requirements
88

9-
- A GNU/Linux or Unix operating system with a graphical user interface (non-headless)
9+
- A GNU/Linux or Unix operating system
1010

11-
- At least one of the following file browsers: Caja, Dolphin, Konqueror, Krusader, Nemo, Nautilus resp. Files, ROX-Filer, Thunar or Xfe
11+
- A a graphical user interface
1212

13-
- bash
13+
- bash 3 or later
14+
15+
- At least one of the supported file browsers below
1416

1517
- A complete Java Runtime Environment (JRE) or Java Developement Kit (JDK) with graphical libraries, version 11 or later. Note: a headless OpenJDK is not suitable to run the HashGarten GUI.
1618

17-
- jacksum-3.7.0.jar, HashGarten-0.14.0.jar, and flatlaf-2.3.jar which are all part of the tarball (see releases)
19+
- jacksum-3.7.0.jar, HashGarten-0.14.0.jar and flatlaf-2.3.jar (all are part of the installation tarball)
1820

19-
## Get the latest Java
21+
### Supported File Browsers
2022

21-
### Debian based Linux (e.g. Ubuntu)
23+
The install script has been tested successfully on many systems. See also the head of the installer script for details.
24+
25+
| File Browser | Tested Versions | API | Comment |
26+
|----------------------|-----------------|----------------------|-------------------------------------------------------------------------------------------------------------|
27+
| Caja | 1.12.0 - 1.26.0 | Caja | Caja is the stardard file manager of the desktop environment MATE. It is a fork of Nautilus version 2.32. |
28+
| Dolphin | 2.2 - 21.12.3 | KDE | Dolphin is the file manager of KDE. |
29+
| Elementary Files | 6.2.1 | Elementary Contracts | Elementary Files is the file manager at Elementary OS. |
30+
| Konqueror | 3.4.1 - 4.4.2 | KDE | Konqueror was the file manager for KDE before it was replaced by Dolphin starting with KDE 4. |
31+
| Krusader | | KDE | Krusader is a file manager for KDE. |
32+
| Nemo | 1.8.4 - 5.2.4 | Nemo | Nemo is the file manager of the desktop environment Cinnamon. It is a fork of Nautilus 3.4. |
33+
| Nautilus resp. Files | 2.6.1 - 24.6 | GNOME | GNOME Files, formerly and internally known as Nautilus, is the official file manager for the GNOME desktop. |
34+
| ROX-Filer | 2.5 - 2.24.33 | ROX | ROX-Filer is the file manager for the desktop environment "ROX Desktop". |
35+
| Thunar | 1.0.1 - 1.6.10 | Thunar | Thunar is a file manager for Linux. |
36+
| Xfe | 1.37 -1.43.2 | Xfe | Xfe is a file manager for Linux. |
37+
38+
39+
## Get started
40+
41+
### Download the latest install script
42+
43+
Go to https://github.com/jonelo/jacksum-fbi-linux/releases and download the .tar.bz2 file.
44+
45+
### Extract the install script
2246

2347
```
24-
$ sudo apt install openjdk-17-jre
48+
$ bunzip2 < jacksum*.tar.bz2 | tar xfv - ; cd jacksum-file-browser-integration/
2549
```
2650

27-
You just need to enter `/usr/bin/java` if the `jacksum-file-browser-integration.sh` asks you for the java command.
51+
### Start the install script
2852

29-
### Other Linux
53+
The script is an interactive text user interface and allows to install Jacksum and HashGarten at your file manager. It also allows to uninstall it again savely. You can run the script as often as you want.
54+
If a file manager is not detected on your system, it is marked as DISABLED.
3055

31-
You could use the `update_jdk` script from the [bashberries](https://github.com/jonelo/bashberries) project in order to get a suitable JDK. The following example downloads Temurin 17 (that is the JDK 17 from adoptium), and installs it to `/opt/java/jdk_latest`:
3256
```
33-
$ sudo ./update_jdk -s "https://github.com/adoptium/temurin17-binaries/releases/download/jdk-17.0.6%2B10/OpenJDK17U-jdk_x64_linux_hotspot_17.0.6_10.tar.gz" -t jdk /opt/java
57+
$ ./jacksum-file-browser-integration.sh
58+
- Jacksum File Browser Integration v2.2.0 -
59+
https://jacksum.net
60+
61+
Menu:
62+
1 - Install Jacksum at Dolphin/Konqueror/Krusader for user johann
63+
2 - Uninstall Jacksum at Dolphin/Konqueror/Krusader for user johann
64+
3 - Install Jacksum at Gnome Nautilus/Files for user johann (DISABLED)
65+
4 - Uninstall Jacksum at Gnome Nautilus/Files for user johann (DISABLED)
66+
5 - Install Jacksum at ROX-Filer for user johann (DISABLED)
67+
6 - Uninstall Jacksum at ROX-Filer for user johann (DISABLED)
68+
7 - Install Jacksum at Thunar for user johann (DISABLED)
69+
8 - Uninstall Jacksum at Thunar for user johann (DISABLED)
70+
9 - Install Jacksum at Xfe for user johann (DISABLED)
71+
10 - Uninstall Jacksum at Xfe for user johann (DISABLED)
72+
11 - Install Jacksum at Nemo for user johann (DISABLED)
73+
12 - Uninstall Jacksum at Nemo for user johann (DISABLED)
74+
13 - Install Jacksum at Caja for user johann (DISABLED)
75+
14 - Uninstall Jacksum at Caja for user johann (DISABLED)
76+
15 - Install Jacksum at Elementary Files for user johann (DISABLED)
77+
16 - Uninstall Jacksum at Elementary Files for user johann (DISABLED)
78+
79+
q - Quit the installer
80+
--------------------------------------------------------------------------------
81+
Select option 1-16 or q to quit:
82+
3483
```
35-
You just need to enter `/opt/java/jdk_latest/bin/java` if the `jacksum-file-browser-integration.sh` asks you for the java command.
3684

37-
## Download the latest install script
85+
## FAQs
3886

39-
Go to https://github.com/jonelo/jacksum-fbi-linux/releases and download the .tar.bz2 file.
87+
## How do I get the latest Java?
4088

41-
## Extract the install script
89+
### Debian based Linux (e.g. Ubuntu)
4290

4391
```
44-
$ bunzip2 < jacksum*.tar.bz2 | tar xfv - ; cd jacksum-file-browser-integration/
92+
$ sudo apt install openjdk-17-jre
4593
```
4694

47-
## Start the install script
48-
95+
You just need to enter `/usr/bin/java` (or hit Enter) if the `jacksum-file-browser-integration.sh` asks you for the java command:
4996
```
5097
$ ./jacksum-file-browser-integration.sh
98+
...
99+
Type the absolute path to "java"
100+
and press "Enter" to continue [/usr/bin/java]:
51101
```
52102

53-
The script is interactive and allows you to install Jacksum and HashGarten at your file manager. It also allows you uninstall it again savely. You can run the script as often as you want.
103+
### Other Linux
54104

55-
## Tested Environments
105+
You could use the `update_jdk` script from the [bashberries](https://github.com/jonelo/bashberries) project in order to get a suitable JDK. The following example downloads Temurin 17 (that is the JDK 17 from adoptium), and installs it to `/opt/java/jdk_latest`:
106+
```
107+
$ sudo ./update_jdk -s "https://github.com/adoptium/temurin17-binaries/releases/download/jdk-17.0.6%2B10/OpenJDK17U-jdk_x64_linux_hotspot_17.0.6_10.tar.gz" -t jdk /opt/java
108+
```
109+
You just need to enter `/opt/java/jdk_latest/bin/java` if the `jacksum-file-browser-integration.sh` asks you for the java command:
110+
111+
```
112+
$ ./jacksum-file-browser-integration.sh
113+
...
114+
Type the absolute path to "java"
115+
and press "Enter" to continue [/usr/bin/java]: /opt/java/jdk_latest/bin/java
116+
```
56117

57-
The script has been tested successfully on many systems. See the head of the installer script for details.
58118

59119
## Bugs, Feature Requests, Support Requests
60120

0 commit comments

Comments
 (0)
Please sign in to comment.