anishathalye / dotbot

A tool that bootstraps your dotfiles ⚡️
MIT License
6.9k stars 287 forks source link

Suggestion for Improved Documentation #362

Open triwats opened 3 weeks ago

triwats commented 3 weeks ago

The primary use case for most Dotbot users involves reinstalling their environment easily and pain-free in scenarios such as:

1.  Replacing a broken work laptop or getting a new device.
2.  Updating periodically after making changes to their environment

Typically, onboarding at a business involves receiving a laptop and being instructed to install necessary software, often leading to context switching and frustration.

Issue:

The README lacks clear instructions for users aiming to reinstall their environment after a period of time. While this is briefly mentioned:

Dotbot makes installing your dotfiles as easy as git clone $url && cd dotfiles && ./install, even on a freshly installed system!

This crucial information would benefit from its own dedicated section.

Suggestion:

Add a new heading and section to the README specifically addressing reinstallation scenarios, detailing steps for users to follow when setting up Dotbot on a new or freshly reset device.