README: list scripts of interest

This commit is contained in:
Matteo Cypriani 2018-05-04 13:23:02 +02:00
parent 7e3d60ad25
commit 2266989c3a
1 changed files with 29 additions and 7 deletions

View File

@ -1,11 +1,33 @@
This repository provides a bunch of scripts that may or may not be of mcy's scripts
interest for you. All are free software, but we use various licenses; =============
the license and copyright information of a script are given in the
file's header.
The scripts are categorised into directories, and each directory This repository provides a bunch of scripts that may or may not be of interest
contains a `README` file with description and usage of each script it for you. They are all free software, but we use various licenses; the license
contains. and copyright information of a script are given in the file's header.
Most scripts are categorised into directories, but "bigger" projects are kept
in their own directories. Each directory contains a `README` file with
description and usage of each script it contains.
Scripts of interest
===================
Here is a list of the main scripts that could be of interest to the general
public:
- The stuff in [file_utils](file_utils/) is quite useful in my opinion,
especially `mvparent` (moves the contents of a directory up one level).
- [dddoc](dddoc/), to extract inline documentation from scripts.
- [audio/just-play-something](audio/), to play random albums on your MPD
server; it is meant to be binded to a button on your music box.
- [graphics/apply-exif-orientation](graphics/): the name speaks for itself,
sometimes useful.
- If you're a Git user, the [git](git/) directory could be of interest.
- [email_account](email_account/), to manage email addresses in a Debian +
Cyrus + Postfix environment.
How to use
==========
For your convenience, the `bin/` directory is maintained with symbolic links For your convenience, the `bin/` directory is maintained with symbolic links
pointing to the scripts in the other directories, so that you can add it pointing to the scripts in the other directories, so that you can add it