diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..e249d08 --- /dev/null +++ b/Makefile @@ -0,0 +1,14 @@ +PREFIX ?= /usr/local +BINDIR ?= $(PREFIX)/bin +MODE = 755 +SCRIPT = rlmariabackup + +.PHONY: all install + +all: + @echo "Run 'make install' to install rlmariabackup" + +install: + install -d $(BINDIR) + install -m $(MODE) $(SCRIPT) $(BINDIR)/ + @echo "rlmariabackup has been installed to $(BINDIR)" \ No newline at end of file diff --git a/README.md b/README.md index ec056a2..3199ce9 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,25 @@ # rlmariabackup -# License +A shell script utility for managing MariaDB backups. -BSD-2-Clause \ No newline at end of file +## Installation + +You can install rlmariabackup using the provided Makefile: + +``` +make install +``` + +This will install the script to `/usr/local/bin`. If you want to install to a different location, you can specify the PREFIX: + +``` +make install PREFIX=/opt +``` + +## Usage + +Run `rlmariabackup help` to see available commands and options. + +## License + +BSD-2-Clause