From cec832f43f8971eb331678ce8d8a66ed9df816d6 Mon Sep 17 00:00:00 2001 From: Squibid Date: Fri, 9 Aug 2024 20:40:20 -0400 Subject: inital commit --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..db46e25 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# Auto .file manager +Auto.s is a dotfile manager written in posix sh. It's main goal is to provide a +simple way to manage your dotfiles without leaving a footprint when it's done. +## How to +For information on arguments run: `auto. -h` +### topography +Auto.s uses a custom file format which is used to define what you want to do. +Currently the topography format supports 4 options which may be used like so: +```topography +# a comment + +$$ echo "a shell command" + +# copying files +filea -> fileb + +# installing programs +:: neovim,firefox,neofetch +``` + +The main advantage of using the custom options over a simple shell script is the +ability to uninstall and install using just one line. + +> [!Important] +> The `::` option is currently only supported on voidlinux, archlinux, and +> debian. If you would like to expand compatibility send [me](mailto:me@zacharyscheiman.com) a patch. -- cgit v1.2.1