CallMeEchoCodes / dossier

:rocket: A lightweight dotfile bootstrapper!

Dossier

🚀 A lightweight dotfile bootstrapper!

🚩 Table of Contents

• Why Use Dossier?
• Contributing
• Used By
• License

🤖 Why Use Dossier?

Dossier is a tool that symlinks your dotfiles to where they should be. Allowing you to setup a computer really fast! While other alternatives exist Dossier aims to be simpler than other alternatives with a good user experience and really fast speeds.

🔧 Installing

Arch linux: <your-aur-manager> -S dossier
Anything else:

# Install https://github.com/charmbracelet/gum using the guide in the README.MD
git clone https://github.com/CallMeEchoCodes/dossier.git
sudo ln -s ./dossier/dossier /usr/bin/

🔧 Contributing

Dossier is open source, so you can create a pull request (PR). Simply git clone and your ready to go!

Setup

Fork main branch into your personal repository. Clone it to local computer. Be sure that you have gum as it's required for the script.

git clone https://github.com/CallMeEchoCodes/Dossier.git

Develop

Fork and simply make your changes and submit a PR

Pull Request

Before uploading your PR, test all features one last time to check if there are any errors. If it has no errors, commit and push it!

🚀 Used By

Echo's Dotfiles

📜 License

This software is licensed under the MPL-2.0 License.