Skip to content

Commit fde34a9

Browse files
committed
Update README.md
1 parent e3026d5 commit fde34a9

File tree

2 files changed

+21
-6
lines changed

2 files changed

+21
-6
lines changed

README.md

+21-6
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,14 @@
33
[![GPLv3 license](https://img.shields.io/badge/License-GPLv3.0-blue.svg)](https://github.com/carlescn/rclone-jobman/blob/main/LICENSE)
44
[![made-with-bash-5.1](https://img.shields.io/badge/Made%20with-Bash%205.1-1f425f.svg?logo=gnubash)](https://www.gnu.org/software/bash/)
55
[![Linux](https://img.shields.io/badge/OS-Linux-yellow.svg?logo=linux)](https://www.linux.org/)
6-
[![rclone-1.53.3](https://img.shields.io/badge/rclone-1.53.3-darkgreen.svg)](https://rclone.org/)
6+
[![Rclone-1.53.3](https://img.shields.io/badge/Depends%20on-Rclone-darkgreen.svg)](https://rclone.org/)
7+
[![whiptail-0.52.21](https://img.shields.io/badge/Depends%20on-whiptail-darkgreen.svg)](https://linux.die.net/man/1/whiptail)
78

89
## About
910

1011
**rclone-jobman** is a "job manager"
11-
that aims to simplify managing multyple sync jobs
12-
with [rclone](https://rclone.org/).
12+
that aims to simplify dealing with multyple sync jobs
13+
with [Rclone](https://rclone.org/).
1314

1415
I first wrote it as a very simple script
1516
for my specific necessities,
@@ -25,6 +26,8 @@ I may change this in the future
2526
and make the arguments job-specific,
2627
saving them on the [job file](#job-files) instead.
2728

29+
![rclone-jobman main menu](screenshot.png)
30+
2831
## Usage
2932

3033
If rclone-jobman is called without any argument
@@ -33,8 +36,9 @@ it will run in interactive mode.
3336
It will print a menu
3437
listing all the available jobs and options
3538
and wait for user input.
36-
Here you can run a sync job
37-
or create/edit/remove one.
39+
You can choose to run a job,
40+
create, edit or remove one,
41+
or read a log file.
3842

3943
Alternatively,
4044
it can be called with only one argument
@@ -103,4 +107,15 @@ I provide a script named
103107
that "installs" all the files
104108
(including the desktop entry and icon)
105109
on the user environment,
106-
and creates the necessary subdirectories under .config.
110+
and creates the necessary subdirectories under .config.
111+
112+
## Dependencies
113+
114+
I've written the script on Bash v5.1, but should work on v4.0. It depens in some preinstalled software:
115+
116+
- [rclone](https://rclone.org/),
117+
for obvious reasons. I've used v1.53.3 while writing the script. I haven't tested it on other versions.
118+
- [whiptail](https://linux.die.net/man/1/whiptail),
119+
to draw the menus and dialog boxes.
120+
It should come pre-installed with most linux distributions
121+
(on some it's part of a package called newt). I've used v0.52.21 while writing the script. I haven't tested it on other versions.

screenshot.png

24.5 KB
Loading

0 commit comments

Comments
 (0)