Skip to content

Commit

Permalink
docs: Update README and Imgs
Browse files Browse the repository at this point in the history
  • Loading branch information
ShinjiMC committed Sep 8, 2024
1 parent c511f25 commit 3643399
Show file tree
Hide file tree
Showing 5 changed files with 86 additions and 2 deletions.
88 changes: 86 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<div align="center">

[![Typing SVG](https://readme-typing-svg.demolab.com?font=Fira+Code&weight=500&size=18&pause=500&color=BBF7F7&width=300&lines=%F0%9F%92%BB+DDD+%2B+Microservices+%F0%9F%92%BB;%F0%9F%92%BB+Software+Engineer+III+%F0%9F%92%BB)](https://git.io/typing-svg)
[![Typing SVG](https://readme-typing-svg.demolab.com?font=Fira+Code&weight=500&size=18&pause=500&color=BBF7F7&width=180&lines=%F0%9F%92%BB+Oh+My+Zsh+%F0%9F%92%BB;%F0%9F%92%BB+Pokemon+%F0%9F%92%BB)](https://git.io/typing-svg)

</div>

Expand All @@ -26,4 +26,88 @@

</div>

##
## Table of Contents

- [Description](#description)
- [Visuals](#visuals)
- [Screenshots](#screenshots)
- [Requirements](#requirements)
- [Installation](#installation)
- [Location of the files](#location-of-the-files)
- [How it works](#how-it-works)
- [Credits](#credits)
- [Author](#author)
- [License](#license)

## Description

The **ZSH Setup Configuration Pro with Pokemon Color Scripts** is a comprehensive setup script designed to configure your ZSH shell environment with essential tools, plugins, and a visually enhanced setup. This script also provides an optional installation of Pokemon color scripts to personalize your terminal experience.

## Visuals

![screenshot](./docs/demo1.png)
![screenshot](./docs/demo2.png)

## Screenshots

![screenshot](./docs/ins0.png)
![screenshot](./docs/ins1.png)

## Requirements

- `python3` - for pokemon color scripts
- `git` - for version control
- `wget` - for downloading installation scripts

## Installation

1. **Clone the repository:**

```bash
git clone https://github.com/ShinjiMC/Zsh-Setup-Pro.git
```

2. **Navigate to the project directory:**

```bash
cd Zsh-Setup-Pro
```

3. **Run the installation script:**

```bash
chmod +x install.sh
./install.sh
```

4. Follow the prompts to install Pokemon color scripts if desired.

## Location of the Files

- **Installation Script:** `install.sh`
- **Configuration Files:** Located in the `assets/` directory within the repository.

## How it Works

The installation script performs the following actions:

1. Installs core ZSH packages.
2. Prompts the user to install Pokemon color scripts.
3. Configures Oh My Zsh and installs necessary plugins.
4. Updates ZSH configuration files and backups existing configurations.
5. Changes the default shell to ZSH if not already set.

## Credits

- **Oh My Zsh:** [https://github.com/ohmyzsh/ohmyzsh](https://github.com/ohmyzsh/ohmyzsh)
- **Zsh Autosuggestions:** [https://github.com/zsh-users/zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions)
- **Zsh Syntax Highlighting:** [https://github.com/zsh-users/zsh-syntax-highlighting](https://github.com/zsh-users/zsh-syntax-highlighting)
- **Pokemon Color Scripts:** [https://gitlab.com/phoneybadger/pokemon-colorscripts](https://gitlab.com/phoneybadger/pokemon-colorscripts)

## Author

- **ShinjiMC** - [GitHub Profile](https://github.com/ShinjiMC)

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
Binary file added docs/demo1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/demo2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ins0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ins1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3643399

Please sign in to comment.