From bf29a79ebea71756b3628f1f7f13d0c07a79ff86 Mon Sep 17 00:00:00 2001 From: Xavier Del Campo Romero Date: Wed, 22 Nov 2023 23:12:41 +0100 Subject: First commit --- README.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..8802bd6 --- /dev/null +++ b/README.md @@ -0,0 +1,59 @@ +# `slcl-upload`, upload directories to a `slcl` instance + +This repository provides [a convenience tool](slcl-upload) that allows to +upload directories recursively to a +[`slcl`](https://gitea.privatedns.org/xavi/slcl) instance. + +## Usage + +Given the following example tree structure and a `slcl` instance running on +`https://example.slcl`: + +``` +$ tree example/ +example/ +├── another-dir +│   └── important-stuff.txt +├── file.jpg +└── video.mp4 +``` + +`example/` can be uploaded using: + +```sh +upload-slcl example / https://example.slcl +``` + +## Why this tool? + +By design, `slcl` uses no JavaScript for its user interface. Unfortunately, +this means there is no way to upload directories, other than requiring users +to create directories manually and then uploading each directory's files +using the HTML form in `slcl`. + +## Requisites + +- A POSIX.1-2008 environment. +- `bash` (requires use of `local` extension). +- `curl`. +- `perl` and its `URI` module. + +## License + +``` +slcl-upload, a tool to upload directories to a slcl instance. +Copyright (C) 2023 Xavier Del Campo Romero + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +``` -- cgit v1.2.3