From 028b9477c5faf10898497deedd834f44b8969588 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ferit=20Yi=C4=9Fit=20BALABAN?= Date: Sun, 7 Apr 2024 23:30:13 +0300 Subject: [PATCH] add program description MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Ferit Yiğit BALABAN --- dotman.py | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/dotman.py b/dotman.py index f326563..ec5f4df 100755 --- a/dotman.py +++ b/dotman.py @@ -1,6 +1,6 @@ #!/usr/bin/env python3 # -# Ferit Yiğit BALABAN , 2023 +# Ferit Yiğit BALABAN , 2024 # import os import shlex @@ -174,3 +174,18 @@ def main(): if __name__ == '__main__': main() +# Description +# dotman is a simple dotfiles manager that can be used to backup and deploy dotfiles. +# +# It manages a git repository to deploy a list of files and directories to +# the local .config directory. When the backup command is executed, it +# copies the files and directories in the deploy_list.json to the +# local repository. git is used to keep track of changes. +# +# Deploying a configuration is possible by either directly calling it, or +# by specifying a git tag. The tag is used to checkout the repository to a +# specific commit, and then deploy the configuration on that time. +# +# Similar to deploying, backing up a configuration is possible by specifying +# a tag name. The tag is created after the files and directories are copied, +# essentially creating a snapshot of the configuration at that time.