Skip to content

Commit c0910a4

Browse files
TheShadyRainbow4TheShadyRainbow4
authored
Revise README for improved documentation and structure
Updated the README to enhance clarity and provide detailed instructions on the tools available in the EliteSoftware Script Tools Archive.
1 parent 7a9c317 commit c0910a4

1 file changed

Lines changed: 163 additions & 2 deletions

File tree

‎README.md‎

Lines changed: 163 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,163 @@
1-
# EliteSoftware-ScriptTools-Archive
2-
All of the tools I have developed using powershll / WinForms or WPF | Some may not work and all are provided AS-IS but feel free to check them out!
1+
<div align="center">
2+
<a href='https://i.postimg.cc/DZTjtNg1/Elite-Software-Company-Simulator-LOGO.png' target='_blank'><img src='https://i.postimg.cc/DZTjtNg1/Elite-Software-Company-Simulator-LOGO.png' border='0' alt='Elite-Software-Client' width="200"></a>
3+
</div>
4+
5+
6+
7+
<div align="center">
8+
9+
# **🧰 EliteSoftware Script Tools Archive 🧰**
10+
11+
</div>
12+
13+
<p align="center">
14+
**Dev-Grade Utilities for the Modern Workflow**
15+
<br />
16+
A comprehensive collection of scripting utilities designed to streamline development.
17+
<br />
18+
<br />
19+
<a href="https://github.com/TheShadyRainbow4/EliteSoftware-ScriptTools-Archive/issues">Report Bug</a>
20+
·
21+
<a href="https://github.com/TheShadyRainbow4/EliteSoftware-ScriptTools-Archive/issues">Request Feature</a>
22+
</p>
23+
24+
25+
26+
<p align="center">
27+
<img src="https://img.shields.io/badge/Maintained%3F-Yes-green.svg" alt="Maintenance">
28+
<img src="https://img.shields.io/github/license/TheShadyRainbow4/EliteSoftware-ScriptTools-Archive" alt="License">
29+
<img src="https://img.shields.io/badge/Built%20with-❤️%20&%20Code-blue.svg" alt="Built with Love and Code">
30+
<br/>
31+
<img src="https://img.shields.io/badge/Python-3.8%2B-blue?logo=python&logoColor=white" alt="Python">
32+
<img src="https://img.shields.io/badge/Node.js-Latest-green?logo=node.js&logoColor=white" alt="Node.js">
33+
<img src="https://img.shields.io/badge/Shell-Bash-4EAA25?logo=gnu-bash&logoColor=white" alt="Bash">
34+
<img src="https://img.shields.io/badge/PowerShell-Core-5391FE?logo=powershell&logoColor=white" alt="PowerShell">
35+
</p>
36+
37+
38+
39+
## **🚀 Overview**
40+
41+
Welcome to the **EliteSoftware Script Tools Archive**.
42+
43+
This repository is a curated collection of scripting utilities and tools maintained by the EliteSoftware team. It is designed to enhance productivity, automate mundane tasks, and streamline development workflows across multiple environments.
44+
45+
Whether you need to automate a deployment, manage Windows registry keys, or process complex data sets, this archive serves as the central hub for our internal dev-tools.
46+
47+
---
48+
49+
## **✨ Available Tools**
50+
51+
The archive allows for a rich, multi-language experience. Here is what is under the hood:
52+
53+
### **🐍 Python Scripts**
54+
Automation utilities for common development tasks.
55+
* **Data Processing:** Advanced transformation tools for large datasets.
56+
* **Config Management:** Scripts to handle environment configurations.
57+
* **Monitoring:** Logging utilities to keep track of system health.
58+
59+
### **🐚 Bash Scripts**
60+
For the Linux/Unix power users.
61+
* **System Admin:** Helpers for daily administrative tasks.
62+
* **Deployment:** Automation scripts for CI/CD pipelines.
63+
* **Build Tools:** Utilities to manage releases and file processing.
64+
65+
### **📦 Node.js Tools**
66+
Modern JavaScript utilities.
67+
* **CLI Apps:** Command-line interfaces for specific workflows.
68+
* **Bundling:** Build and bundling utilities.
69+
* **Asset Management:** Tools to handle static assets and dev server enhancements.
70+
71+
### **⚡ PowerShell Scripts**
72+
Windows ecosystem management.
73+
* **System Automation:** Deep Windows system integration.
74+
* **Registry Tools:** Configuration and registry manipulation.
75+
* **Batch Operations:** Process management utilities.
76+
77+
---
78+
79+
## **🛠️ Getting Started**
80+
81+
Ready to optimize your workflow? Here is how to get the tools running on your machine.
82+
83+
### **Prerequisites**
84+
85+
Before using the EliteSoftware Script Tools, ensure you have the following installed:
86+
* **Git:** For version control.
87+
* **Python:** Version 3.8+ (for Python-based scripts).
88+
* **Node.js:** Latest stable version (for JS tools).
89+
* **Shell:** An appropriate environment (Bash, PowerShell, or Zsh).
90+
91+
### **Installation & Setup**
92+
93+
1. **Clone the repo:**
94+
95+
```bash
96+
git clone [https://github.com/TheShadyRainbow4/EliteSoftware-ScriptTools-Archive.git](https://github.com/TheShadyRainbow4/EliteSoftware-ScriptTools-Archive.git)
97+
cd EliteSoftware-ScriptTools-Archive
98+
```
99+
100+
2. **Explore the tools:**
101+
102+
```bash
103+
ls -la
104+
```
105+
106+
### **Language-Specific Setup**
107+
108+
<details>
109+
<summary><b>🐍 For Python Scripts</b></summary>
110+
111+
1. **Install dependencies:**
112+
```bash
113+
pip install -r requirements.txt
114+
```
115+
2. **Configure environment:**
116+
```bash
117+
cp .env.example .env
118+
# Edit .env with your configuration
119+
```
120+
3. **Verify:**
121+
```bash
122+
python -m scripts --version
123+
```
124+
</details>
125+
126+
<details>
127+
<summary><b>🐚 For Bash Scripts</b></summary>
128+
129+
1. **Make executable:**
130+
```bash
131+
chmod +x scripts/bash/*.sh
132+
```
133+
2. **Add to PATH (Optional):**
134+
```bash
135+
export PATH="$PATH:$(pwd)/scripts/bash"
136+
```
137+
3. **Test:**
138+
```bash
139+
./scripts/bash/example-script.sh --help
140+
```
141+
</details>
142+
143+
<details>
144+
<summary><b>📦 For Node.js Tools</b></summary>
145+
146+
1. **Install dependencies:**
147+
```bash
148+
npm install
149+
```
150+
2. **Global install (Optional):**
151+
```bash
152+
npm install -g .
153+
```
154+
3. **Verify:**
155+
```bash
156+
npm run test
157+
```
158+
</details>
159+
160+
---
161+
162+
## **📂 Repository Structure**
163+

0 commit comments

Comments
 (0)