dotfiles-installer

README

🛠️ Dotfiles Installer

Welcome to Dotfiles Installer! This tool helps you to install and manage your dotfiles with ease.

🚀 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

📋 Prerequisites

• Go (version 1.20 or later)

🏗️ Installation

Clone the repository:

git clone https://github.com/Mephisto-Grumpy/dotfiles-installer.git

Build the project:

cd dotfiles-installer
make # or make build

This will generate a dotfiles-installer binary in your current directory.

🏃🏻‍♂️ Running the tests

go test -race -coverprofile=coverage.out -covermode=atomic -tags test ./...

🐳 Docker for testing

docker build -t dotfiles-installer .
docker run --rm -it -v $(pwd)/bin/*:/home/ubuntu/bin dotfiles-installer

📖 Usage

./dotfiles-installer -h # or ./dotfiles-installer --help

🛠️ Built With

• Go - The Go Programming Language
• GitHub Actions - CI/CD
• CMake - Build System

✍🏻 Authors

• Mephisto - Initial work - Mephisto-Grumpy
• PunGrumpy - Development - PunGrumpy

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.