Installing the `dot` executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install dot_rust

It will make the dot command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall dot_rust uninstalls.

Back to the crate overview.

Readme

Dot - A simple Dotfiles Manager

A simple and elegant dotfile manager for Unix-like systems.

dot helps you manage your configuration files (dotfiles) by creating symbolic links from a centralized repository to their intended locations in your home directory (or wherever you want).

Features

Initialize: Create a new dotfiles repository.
Add: Start tracking a new dotfile.
Remove: Stop tracking a dotfile.
Sync: Synchronize all your dotfiles, creating symbolic links.

Installation

From Crates.io

You can install dot using cargo:

cargo install dot_rust

Build from Source

Clone the repository:

git clone https://github.com/rvillegasm/dot.git

Navigate to the project directory:
```
cd dot
```
Build the project:
```
cargo build --release
```
The binary will be located at target/release/dot. You can move it to a directory in your $PATH.

Usage

# Initialize a new dot repository (defaults to ~/.dotfiles)
dot init

# Add a file to track
dot add ~/.vimrc

# Sync all tracked files
dot sync

# Remove a tracked file
dot remove .vimrc

Contributing

Contributions are welcome! Please feel free to open an issue or submit a pull request if you have any ideas, suggestions, or bug reports.

Code of Conduct

We adhere to the Contributor Covenant Code of Conduct. All contributors are expected to uphold this code.

License

This project is licensed under the MIT License. See the LICENSE.txt file for details.

Contact

Rafael Villegas - @rvillegasm - [email protected]

Installing the dot executable

Installing the `dot` executable