Skip to content

Commit

Permalink
chore: improve Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
YasminTeles committed May 28, 2024
1 parent 2f1be11 commit 6e42441
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 17 deletions.
37 changes: 20 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,23 @@
# Yasmin´s dotfiles
![My dotfiles is now installed!](/images/banner.webp "My dotfiles is now installed!")

# Yasmin's dotfiles

Welcome to my dotfiles repository!

This project is a curated collection of configuration files and scripts tailored to enhance my daily development experience.
My dotfiles are designed to simplify my workflow, customize my development environment, and improve my daily development experience.

> [!WARNING]
> Note that I use this project to save my configuration files for personal use. Some of them may not work for you.
Do you want to learn more about dotfiles?

My dotfiles are designed to simplify my workflow, customize my development environment, and ensure a consistent configuration.
Check out the guide [Customize, Simplify, and Automate Your Workspace With Dotfiles](https://yasminteles.com/blog/customize-simplify-and-automate-your-workspace-with-dotfiles).

Feel free to explore, adapt, and copy parts of these dotfiles into your own dotfiles. Enjoy!

## Installation

Insert this into a macOS Terminal or Linux shell prompt. The script will detail its actions and then halt before executing them.
Insert this into a macOS terminal. The script will detail its actions and then halt before executing them.

```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/YasminTeles/dotfiles/main/install.sh)"
Expand All @@ -18,12 +27,10 @@ Insert this into a macOS Terminal or Linux shell prompt. The script will detail

All my command-line tools, applications, and their configurations. Have fun 😎💅

- Git
- Stow
- Oh My Zsh
- SSH key generation
- Create a Projects folder
- A bunch of productivity apps. See [Brewfile](/brew/Brewfile) for more information.
- iTerm, zsh and Oh My Zsh. Spaceship for theme.
- Git and SSH key generation. See [gitconfig](/git/.gitconfig) for more information about my Git aliases.
- Create a Projects folder. For clone all projects in GitHub, try `make github`.
- Homebrew and a bunch of productivity apps. See [Brewfile](/brew/Brewfile) for more information.

## Helper

Expand All @@ -37,19 +44,15 @@ A set of environment management commands is available at `Makefile`. To access t

This script is designed to remove all configurations of your environment. **Please proceed with caution** as this action is irreversible.

### Instructions
> [!CAUTION]
> Ensure you have **backups** of any important configurations before running this script.
Enter this command into a macOS Terminal or Linux shell prompt. The script will outline its actions.
Enter this command into a macOS terminal. The script will outline its actions.

```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/YasminTeles/dotfiles/main/uninstall.sh)"
```

> [!CAUTION]
> Ensure you have **backups** of any important configurations before running this script.
By following these steps, you can safely remove all configurations of the environment as needed.

## License

This project is licensed under the [MIT License](LICENSE).
Expand Down
Binary file added images/banner.webp
Binary file not shown.

0 comments on commit 6e42441

Please sign in to comment.