diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 26 |
1 files changed, 26 insertions, 0 deletions
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. |