Skip to content

Commit 43a857e

Browse files
Fourteenth version with update Readme.md
1 parent 3959aa0 commit 43a857e

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

Readme.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,10 @@
4949
cd /path/to/your/target-project
5050

5151
# Move the entire README creator folder into your project
52-
mv /path/to/Readme.md-File-Creator-With-AI-Python ./Readme-Creator
52+
mv /path/to/Readme.md-File-Creator-With-AI-Python ./Readme.md-File-Creator-With-AI-Python
5353

5454
# Or copy if you want to keep the original
55-
cp -r /path/to/Readme.md-File-Creator-With-AI-Python ./Readme-Creator
55+
cp -r /path/to/Readme.md-File-Creator-With-AI-Python ./Readme.md-File-Creator-With-AI-Python
5656
```
5757

5858
**Your project structure should look like this:**
@@ -61,7 +61,7 @@
6161
├── src/ # Your existing project files
6262
├── tests/ # Your existing project files
6363
├── package.json # Your existing project files
64-
├── Readme-Creator/ # ← The downloaded folder goes here
64+
├── Readme.md-File-Creator-With-AI-Python/ # ← The downloaded folder goes here
6565
│ ├── Config.json
6666
│ ├── Readme.md-File-Creator.py
6767
│ ├── License-Creator.py
@@ -86,7 +86,7 @@
8686
Navigate to the `Readme-Creator` folder and edit the `Config.json` file with your project details:
8787

8888
```bash
89-
cd Readme-Creator
89+
cd Readme.md-File-Creator-With-AI-Python
9090
```
9191

9292
Edit `Config.json`:
@@ -144,21 +144,21 @@ Edit `Config.json`:
144144
#### Method 1: Run All (Recommended)
145145
Navigate to the Readme-Creator folder and run:
146146
```bash
147-
cd Readme-Creator
147+
cd Readme.md-File-Creator-With-AI-Python
148148
python RUN.py
149149
```
150150
This will generate both README.md and LICENSE files in your main project directory.
151151

152152
#### Method 2: Individual Scripts
153153
Generate only README:
154154
```bash
155-
cd Readme-Creator
155+
cd Readme.md-File-Creator-With-AI-Python
156156
python Readme.md-File-Creator.py
157157
```
158158

159159
Generate only LICENSE:
160160
```bash
161-
cd Readme-Creator
161+
cd Readme.md-File-Creator-With-AI-Python
162162
python License-Creator.py
163163
```
164164

@@ -168,7 +168,7 @@ python License-Creator.py
168168
Your-Target-Project/
169169
├── src/ # Your existing project files
170170
├── tests/ # Your existing project files
171-
├── Readme-Creator/ # README creator tool folder
171+
├── Readme.md-File-Creator-With-AI-Python/ # README creator tool folder
172172
│ ├── Config.json # Configuration file
173173
│ ├── License-Creator.py # License generation script
174174
│ ├── Readme.md-File-Creator.py # README generation script
@@ -184,7 +184,7 @@ Your-Target-Project/
184184

185185
### 🔧 How It Works
186186

187-
1. **Configuration Reading**: Scripts read your project details from `Readme-Creator/Config.json`
187+
1. **Configuration Reading**: Scripts read your project details from `Readme.md-File-Creator-With-AI-Python/Config.json`
188188
2. **Project Analysis**: The tool scans your main project directory (excluding the Readme-Creator folder) and creates a file tree
189189
3. **AI Generation**: Google Gemini AI generates professional README content based on your project
190190
4. **Multi-Language Support**: Content is translated to specified languages
@@ -213,7 +213,7 @@ The tool comes with pre-installed license templates:
213213
- **Mozilla Public License 2.0**
214214
- **The Unlicense**
215215

216-
*All license templates are included in the `Readme-Creator/Licenses/` directory by default.*
216+
*All license templates are included in the `Readme.md-File-Creator-With-AI-Python/Licenses/` directory by default.*
217217

218218
### 🚨 Error Handling
219219

@@ -228,9 +228,9 @@ The tool includes comprehensive error handling for:
228228
### 🎨 Customization
229229

230230
You can customize the generated README by:
231-
- Modifying the AI prompts in `Readme-Creator/Readme.md-File-Creator.py`
232-
- Adding new license templates to the `Readme-Creator/Licenses/` directory
233-
- Adjusting the ignore list in `Readme-Creator/Config.json` (remember to keep "Readme-Creator" in the ignore list)
231+
- Modifying the AI prompts in `Readme.md-File-Creator-With-AI-Python/Readme.md-File-Creator.py`
232+
- Adding new license templates to the `Readme.md-File-Creator-With-AI-Python/Licenses/` directory
233+
- Adjusting the ignore list in `Readme.md-File-Creator-With-AI-Python/Config.json` (remember to keep "Readme.md-File-Creator-With-AI-Python-master" in the ignore list)
234234
- Adding more languages to the `languages` array
235235

236236
### 📄 License
@@ -280,10 +280,10 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
280280
cd /path/to/your/hedef-proje
281281

282282
# README creator klasörünü projenize taşıyın
283-
mv /path/to/Readme.md-File-Creator-With-AI-Python ./Readme-Creator
283+
mv /path/to/Readme.md-File-Creator-With-AI-Python ./Readme.md-File-Creator-With-AI-Python
284284

285285
# Ya da kopyalamak isterseniz
286-
cp -r /path/to/Readme.md-File-Creator-With-AI-Python ./Readme-Creator
286+
cp -r /path/to/Readme.md-File-Creator-With-AI-Python ./Readme.md-File-Creator-With-AI-Python
287287
```
288288

289289
**Proje yapınız şu şekilde görünmelidir:**
@@ -292,7 +292,7 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
292292
├── src/ # Mevcut proje dosyalarınız
293293
├── tests/ # Mevcut proje dosyalarınız
294294
├── package.json # Mevcut proje dosyalarınız
295-
├── Readme-Creator/ # ← İndirilen klasör buraya gelir
295+
├── Readme.md-File-Creator-With-AI-Python/ # ← İndirilen klasör buraya gelir
296296
│ ├── Config.json
297297
│ ├── Readme.md-File-Creator.py
298298
│ ├── License-Creator.py
@@ -314,10 +314,10 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
314314

315315
### ⚙️ Yapılandırma
316316

317-
`Readme-Creator` klasörüne gidin ve `Config.json` dosyasını proje detaylarınızla düzenleyin:
317+
`Readme.md-File-Creator-With-AI-Python` klasörüne gidin ve `Config.json` dosyasını proje detaylarınızla düzenleyin:
318318

319319
```bash
320-
cd Readme-Creator
320+
cd Readme.md-File-Creator-With-AI-Python
321321
```
322322

323323
`Config.json`'ı düzenleyin:
@@ -375,21 +375,21 @@ cd Readme-Creator
375375
#### Yöntem 1: Hepsini Çalıştır (Önerilen)
376376
Readme-Creator klasörüne gidin ve çalıştırın:
377377
```bash
378-
cd Readme-Creator
378+
cd Readme.md-File-Creator-With-AI-Python
379379
python RUN.py
380380
```
381381
Bu hem README.md hem de LICENSE dosyalarını ana proje dizininizde oluşturacaktır.
382382

383383
#### Yöntem 2: Tekil Scriptler
384384
Sadece README oluştur:
385385
```bash
386-
cd Readme-Creator
386+
cd Readme.md-File-Creator-With-AI-Python
387387
python Readme.md-File-Creator.py
388388
```
389389

390390
Sadece LICENSE oluştur:
391391
```bash
392-
cd Readme-Creator
392+
cd Readme.md-File-Creator-With-AI-Python
393393
python License-Creator.py
394394
```
395395

@@ -399,7 +399,7 @@ python License-Creator.py
399399
Hedef-Projeniz/
400400
├── src/ # Mevcut proje dosyalarınız
401401
├── tests/ # Mevcut proje dosyalarınız
402-
├── Readme-Creator/ # README creator araç klasörü
402+
├── Readme.md-File-Creator-With-AI-Python/ # README creator araç klasörü
403403
│ ├── Config.json # Yapılandırma dosyası
404404
│ ├── License-Creator.py # Lisans oluşturma scripti
405405
│ ├── Readme.md-File-Creator.py # README oluşturma scripti
@@ -459,9 +459,9 @@ Araç kapsamlı hata yönetimi içerir:
459459
### 🎨 Özelleştirme
460460

461461
Oluşturulan README'yi şu şekillerde özelleştirebilirsiniz:
462-
- `Readme-Creator/Readme.md-File-Creator.py`'deki AI promptlarını değiştirerek
463-
- `Readme-Creator/Licenses/` dizinine yeni lisans şablonları ekleyerek
464-
- `Readme-Creator/Config.json`'daki ignore listesini ayarlayarak ("Readme-Creator"ı ignore listesinde tutmayı unutmayın)
462+
- `Readme.md-File-Creator-With-AI-Python/Readme.md-File-Creator.py`'deki AI promptlarını değiştirerek
463+
- `Readme.md-File-Creator-With-AI-Python/Licenses/` dizinine yeni lisans şablonları ekleyerek
464+
- `Readme.md-File-Creator-With-AI-Python/Config.json`'daki ignore listesini ayarlayarak ("Readme-Creator"ı ignore listesinde tutmayı unutmayın)
465465
- `languages` dizisine daha fazla dil ekleyerek
466466

467467
### 📄 Lisans

0 commit comments

Comments
 (0)