docs: update READMEs with CI/CD guide for teammates
This commit is contained in:
@@ -1,38 +1,35 @@
|
||||
# Audio Voice Converter
|
||||
# audio-voice-converter
|
||||
|
||||
مبدل صوت به ویس — ابزاری برای تبدیل فایلهای صوتی به فرمتهای مختلف و پردازش صدا.
|
||||
ابزارها و extensionهای مرتبط با تبدیل صوت، caption، و transcript در Google Meet.
|
||||
|
||||
## هدف
|
||||
## محتوا
|
||||
|
||||
تبدیل فایلهای صوتی (mp3، wav، ogg و ...) به فرمت voice message قابل استفاده در پیامرسانها.
|
||||
| پوشه | توضیح |
|
||||
|------|-------|
|
||||
| `google-meet-transcripts-extension/` | Chrome extension برای transcript و خلاصهسازی جلسات Google Meet (ID: `gjapjdfoanfgoeliolnigeieiibnefkp`) |
|
||||
| `caption-extension/` | Chrome extension برای caption و ضبط گفتگو در Google Meet |
|
||||
| `deploy/` | اسکریپتهای CI/CD برای sync و push |
|
||||
|
||||
## ساختار پروژه
|
||||
## شروع سریع
|
||||
|
||||
```
|
||||
audio-voice-converter/
|
||||
├── README.md
|
||||
├── src/ # کد اصلی
|
||||
├── tests/ # تستها
|
||||
└── samples/ # نمونه فایلهای صوتی
|
||||
```powershell
|
||||
# ۱. کلون
|
||||
git clone https://git.darkreader.ir/arash/audio-voice-converter.git
|
||||
cd audio-voice-converter
|
||||
|
||||
# ۲. مسیر source را تنظیم کن
|
||||
$env:AUDIO_SOURCE_ROOT = "مسیر پوشهای که extensionها توشن"
|
||||
|
||||
# ۳. sync + push
|
||||
.\deploy\scripts\sync.ps1
|
||||
.\deploy\scripts\push.ps1
|
||||
```
|
||||
|
||||
## نصب و راهاندازی
|
||||
راهنمای کاملتر در [`deploy/README.md`](deploy/README.md).
|
||||
|
||||
```bash
|
||||
# TODO
|
||||
```
|
||||
## نصب extension در Chrome
|
||||
|
||||
## استفاده
|
||||
|
||||
```bash
|
||||
# TODO
|
||||
```
|
||||
|
||||
## وابستگیها
|
||||
|
||||
- TODO
|
||||
|
||||
## مشارکت
|
||||
|
||||
این پروژه روی Gitea در آدرس زیر هاست شده:
|
||||
`http://194.180.11.201:3000/arash/audio-voice-converter`
|
||||
1. Chrome → `chrome://extensions` → Developer mode را روشن کن
|
||||
2. **Load unpacked** → پوشهی موردنظر را انتخاب کن:
|
||||
- برای transcripts: پوشه `google-meet-transcripts-extension/`
|
||||
- برای caption: پوشه `caption-extension/`
|
||||
|
||||
+27
-15
@@ -1,39 +1,51 @@
|
||||
# Deploy — audio-voice-converter
|
||||
|
||||
اسکریپتهای CI/CD پروژه `audio-voice-converter`.
|
||||
اسکریپتهای CI/CD برای sync کردن extensionها از source و push به Gitea.
|
||||
|
||||
## ساختار
|
||||
|
||||
```
|
||||
deploy/
|
||||
├── README.md ← این فایل
|
||||
├── README.md
|
||||
└── scripts/
|
||||
├── sync.ps1 ← کپی فایلها از source به repo
|
||||
├── sync.ps1 ← کپی فایلها از source dirs به repo
|
||||
└── push.ps1 ← git commit + push به Gitea
|
||||
```
|
||||
|
||||
## پیشنیازها
|
||||
|
||||
- متغیر محیطی `AUDIO_SOURCE_ROOT` تنظیم شده باشه (مسیر پوشهی source)
|
||||
- دسترسی git به remote (credential یا SSH key)
|
||||
## یکبار (اولین بار)
|
||||
|
||||
```powershell
|
||||
$env:AUDIO_SOURCE_ROOT = "D:\projects\google_meet_captions"
|
||||
git clone https://git.darkreader.ir/arash/audio-voice-converter.git
|
||||
cd audio-voice-converter
|
||||
```
|
||||
|
||||
## استفاده
|
||||
## هر بار که extension آپدیت شد
|
||||
|
||||
```powershell
|
||||
# فقط sync (کپی فایلها بدون push)
|
||||
.\scripts\sync.ps1
|
||||
# مسیر پوشهای که extensionهای source توشن
|
||||
$env:AUDIO_SOURCE_ROOT = "مسیر پوشه source"
|
||||
|
||||
# sync + commit + push
|
||||
.\scripts\sync.ps1 | .\scripts\push.ps1
|
||||
# sync فایلها از source
|
||||
.\deploy\scripts\sync.ps1
|
||||
|
||||
# یا مستقیم push (اگر sync قبلاً انجام شده)
|
||||
.\scripts\push.ps1
|
||||
# commit + push به Gitea
|
||||
.\deploy\scripts\push.ps1
|
||||
```
|
||||
|
||||
## گزینههای push.ps1
|
||||
|
||||
```powershell
|
||||
.\deploy\scripts\push.ps1 # پیام خودکار با timestamp
|
||||
.\deploy\scripts\push.ps1 -Message "fix: ..." # پیام دلخواه
|
||||
.\deploy\scripts\push.ps1 -DryRun # فقط نمایش، بدون push
|
||||
```
|
||||
|
||||
## نکات
|
||||
|
||||
- `$env:AUDIO_SOURCE_ROOT` نباید توی هیچ فایلی ذخیره بشه — هر بار در terminal تنظیم کن
|
||||
- `push.ps1` با `--force` پوش میکنه چون این repo snapshot هست نه تاریخچه
|
||||
- آدرس Gitea: `https://git.darkreader.ir`
|
||||
|
||||
## جریان کلی
|
||||
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user