diff --git a/README.md b/README.md index 290e9f9..d24a5ba 100644 --- a/README.md +++ b/README.md @@ -1,117 +1,226 @@ -# dotfiles -```shell -git clone https://gitea.tomastm.com/tomas.mirchev/dotfiles.git ~/.dotfiles -cd ~/.dotfiles -./install.py +# Dotfiles + +## How to Use + +First, clone the repository: + +```sh +git clone https://gitea.tomastm.com/tomas.mirchev/dotfiles.git ~/.dotfiles && cd ~/.dotfiles ``` -Do not forget to change the remote from https to ssh -```shell +The `setup` script will automatically update the remote repository URL. However, if you are configuring the dotfiles manually, make sure to change it after adding your SSH key: + +```sh git remote set-url origin git@gitea.tomastm.com:tomas.mirchev/dotfiles.git git remote -v ``` -### Todo -- [ ] Uninstall option -- [ ] Fix inconsistencies with usage fn +The `manage.py` script allows you to link configurations, install packages, and set up environments. To view available arguments, use: + +```sh +manage.py -h +manage.py -h +``` + +### Common Commands: + +- `manage.py link [--copy] [-f|--force] [-p|--package]` +- `manage.py install [-p|--package]` +- `manage.py setup [--extra]` + +You can create multiple environments, following this structure: + +- `config/` +- `config.json` (add `` to the JSON file) +- `setups/` +- Any additional scripts can be placed in `scripts/