Skip to content

Commit b970003

Browse files
author
egor.savelev
committed
update readme
1 parent 0dde6c5 commit b970003

1 file changed

Lines changed: 79 additions & 32 deletions

File tree

README.md

Lines changed: 79 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,120 @@
11
# 🛠️ TerminalBuild
22

3-
TerminalBuild — это коллекция скриптов для быстрой настройки окружения терминала и редактора Visual Studio Code. Скрипты автоматически устанавливают/удаляют полезные утилиты, настраивают удобные бинды и делают работу в терминале более комфортной.
3+
TerminalBuild is a collection of scripts for quick terminal environment and Visual Studio Code setup. The scripts automatically install/remove useful utilities, configure convenient aliases, and make your terminal experience more comfortable.
44

55
---
66

7-
## Предварительные шаги
7+
## Prerequisites
88

9-
Перед установкой убедитесь, что выполнены следующие действия:
9+
Before installation, make sure you have the following:
1010

11-
1. Выполнить
12-
```
11+
1. Update packages and install git:
12+
```bash
1313
sudo apt update
1414
sudo apt install git -y
1515
```
1616

17-
2. (Опционально) Установите Visual Studio Code
18-
```
17+
2. (Optional) Install Visual Studio Code:
18+
```bash
1919
sudo apt install code
2020
```
21+
22+
> **Note:** If you're running as root, VS Code commands require `--no-sandbox` flag. The scripts handle this automatically.
23+
2124
---
2225

23-
## ⚙️ Установка и запуск
26+
## ⚙️ Installation
2427

25-
1. Склонируйте репозиторий
26-
```
28+
1. Clone the repository:
29+
```bash
2730
git clone https://github.com/melisha-git/TerminalBuild.git
2831
```
29-
2. Установите
30-
```
32+
33+
2. Run the setup:
34+
```bash
3135
cd TerminalBuild
32-
chmod +x install.sh
36+
chmod +x install.sh vscode-tools-install.sh
3337
./install.sh
34-
./vscode-tools-install.sh # (опционально)
35-
exec zsh #or source .zshrc
38+
./vscode-tools-install.sh # (optional)
39+
exec zsh # or: source ~/.zshrc
3640
```
41+
42+
Each script will ask for confirmation before installing any component — nothing is forced.
43+
3744
---
3845

39-
## Удаление
46+
## 🧹 Uninstallation
4047

41-
Для удаления установленных компонентов:
42-
```
48+
To remove installed components:
49+
50+
```bash
4351
cd TerminalBuild
44-
chmod +x uninstall.sh
52+
chmod +x uninstall.sh vscode-tools-uninstall.sh
4553
./uninstall.sh
46-
./vscode-tools-uninstall.sh # (опционально)
54+
./vscode-tools-uninstall.sh # (optional)
4755
```
56+
57+
Each component can be skipped individually during removal.
58+
4859
---
4960

50-
## Структура проекта
61+
## 📦 What's Included
62+
63+
| Component | Description |
64+
|---|---|
65+
| **Oh My Zsh** | Zsh configuration framework |
66+
| **Powerlevel10k** | Fast and customizable Zsh theme |
67+
| **fzf** | Fuzzy file finder with preview |
68+
| **eza** | Modern replacement for `ls` with icons and git support |
69+
| **VS Code Extensions** | 30+ extensions for Python, C++, Docker, Remote SSH, and more |
70+
71+
---
72+
73+
## 📁 Project Structure
74+
5175
```
5276
TerminalBuild/
53-
├── install.sh # Установка основных утилит
54-
├── vscode-tools-install.sh # Установка расширений и настроек для VSCode
55-
├── vscode-tools-uninstall.sh# Удаление VSCode-настроек
56-
└── README.md # Документация проекта
77+
├── install.sh # Terminal utilities installer
78+
├── uninstall.sh # Terminal utilities uninstaller
79+
├── vscode-tools-install.sh # VS Code + extensions installer
80+
├── vscode-tools-uninstall.sh # VS Code + extensions uninstaller
81+
└── README.md # Documentation
5782
```
83+
5884
---
5985

60-
## Планируемые улучшения (TODO)
86+
## 📋 Summary Output
6187

62-
* [ ] GUI-меню выбора устанавливаемых пакетов
63-
* [ ] Обновление через git pull и перезапуск скриптов
88+
Both install and uninstall scripts display a summary table at the end:
6489

65-
---
90+
```
91+
===========================================
92+
📋 Installation Summary
93+
===========================================
94+
COMPONENT STATUS
95+
────────────────────────────────────────
96+
git 🔵 Already existed
97+
curl 🔵 Already existed
98+
zsh 🟢 Installed
99+
oh-my-zsh 🟢 Installed
100+
powerlevel10k 🟢 Installed
101+
fzf 🟢 Installed
102+
build-essential 🔵 Already existed
103+
eza 🟢 Installed
104+
===========================================
105+
```
66106

67-
## Автор
107+
---
68108

69-
[@melisha-git](https://github.com/melisha-git)
109+
## 🗺️ Roadmap
70110

71-
Pull Requests и Issues приветствуются!
111+
- [ ] Interactive GUI menu for selecting packages
112+
- [ ] Self-update via `git pull` and script restart
72113

73114
---
115+
116+
## Author
117+
118+
[**@melisha-git**](https://github.com/melisha-git)
119+
120+
Pull Requests and Issues are welcome!

0 commit comments

Comments
 (0)