Skip to content

Commit

Permalink
chore: improve Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
YasminTeles committed Apr 8, 2024
1 parent 2f1be11 commit fe9bfc5
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# Yasmin´s dotfiles
# 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.

My dotfiles are designed to simplify my workflow, customize my development environment, and ensure a consistent configuration.
> [!WARNING]
> Note that I use this project to save my configuration files for personal use. Some of them may not work for you.
## 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 +19,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.
- 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 @@ -39,7 +38,7 @@ This script is designed to remove all configurations of your environment. **Plea

### Instructions

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)"
Expand Down

0 comments on commit fe9bfc5

Please sign in to comment.