From ac0e53b5a29cf87761255643b5816e19c9a482a7 Mon Sep 17 00:00:00 2001 From: jozan Date: Fri, 27 Nov 2020 23:46:59 +0000 Subject: Goodio README FossilOrigin-Name: ece099d04a497ae2f379f93bd3c433964784111ff653b711c4b3477075fdce3f --- README.md | 48 +++++++++++++++++++++++++++++------------------- README.org | 2 +- 2 files changed, 30 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 9786382..79709f2 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # Table of Contents -1. [Dependencies](#org0b55cd2) -2. [Installation](#orgc36ed01) -3. [Usage](#org06b1425) -4. [End note](#orgd171c54) +1. [Dependencies](#org0cfb26c) +2. [Installation](#orge26b09a) +3. [Usage](#orgaf1a9db) +4. [End note](#orgf54857b) **unixize** is a small tool to bulk rename files into a cool UNIX-friendly standard. Basically, everything becomes lowercase and there is no need to @@ -13,12 +13,14 @@ also removes unicode characters. **unixize** is configurable through options. Refer to - man unixize +```sh +man unixize +``` to get a list of options. - + # Dependencies @@ -26,7 +28,7 @@ to get a list of options. - GNU Make - + # Installation @@ -34,7 +36,7 @@ You can get **unixize** either through `git` or `fossil`. For `fossil` use: -``` shell +```sh mkdir unixize cd unixize fossil clone https://chiselapp.com/user/JozanLeClerc/repository/unixize unixize.fossil @@ -43,36 +45,44 @@ fossil open --force unixize.fossil or for `git`: - git clone git://jozanleclerc.xyz/jozan/unixize.git - cd unixize +```sh +git clone git://jozanleclerc.xyz/jozan/unixize.git +cd unixize +``` Then build the program: - make - sudo make install clean +```sh +make +sudo make install clean +``` Note that on BSD systems you want to use `gmake` instead of `make`: - gmake - sudo gmake install clean +```sh +gmake +sudo gmake install clean +``` - + # Usage -**USE WITH CAUTION**. +**USE WITH CAUTION!** Without the `-p` option, **unixize** will commit to do exactly what it's supposed to do, rename all the badly formatted in the chosen directory. To deunixize your files, you'll have to rename everything manually. - cd messy_directory - unixize -v -r . +```sh +cd messy_directory +unixize -v -r . +``` - + # End note diff --git a/README.org b/README.org index 10e5860..75308ad 100644 --- a/README.org +++ b/README.org @@ -42,7 +42,7 @@ sudo gmake install clean #+END_SRC * Usage -*USE WITH CAUTION*. +*USE WITH CAUTION!* Without the ~-p~ option, *unixize* will commit to do exactly what it's supposed to do, rename all the badly formatted in the chosen -- cgit v1.2.3