Skip to content

Commit

Permalink
Added a README file.
Browse files Browse the repository at this point in the history
  • Loading branch information
pjotrsavitski committed Sep 4, 2022
1 parent 83f5354 commit 9f4ff2b
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Cleanup utility

The utility will keep up to **N** (defaults to 5) of the latest subdirectories and removes all the others.

Modification time will be used when determining the sort order of subdirectories.

## Usage examples

* `cleanup <PATH-TO-DIRECTORY> -l 5` keeps up to 5 latest subdirectories of the path provided
* `cleanup <PATH-TO-DIRECTORY>` keeps up to 5 (default value) subdirectories of the path provided
* `cleanup -v` displays the version information of the utility script
* `cleanup` - displays help text of the utility script

## Building

Build the binaries by running `./go-executable-build.bash` and check the **data** directory for resulting binaries. You
may change the defined platform as needed.

Default platforms are `linux/386`, `linux/amd64` and `darwin/amd64`.

0 comments on commit 9f4ff2b

Please sign in to comment.