From 2266989c3a0601c49b150b1f4faf311def62dfed Mon Sep 17 00:00:00 2001 From: Matteo Cypriani Date: Fri, 4 May 2018 13:23:02 +0200 Subject: [PATCH] README: list scripts of interest --- README.md | 36 +++++++++++++++++++++++++++++------- 1 file changed, 29 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b6bfd5c..ba9a1b7 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,33 @@ -This repository provides a bunch of scripts that may or may not be of -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. +mcy's scripts +============= -The scripts are categorised into directories, and each directory -contains a `README` file with description and usage of each script it -contains. +This repository provides a bunch of scripts that may or may not be of interest +for you. They are all free software, but we use various licenses; the license +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 pointing to the scripts in the other directories, so that you can add it