Skip to content

Commit 31ac08c

Browse files
committed
refactor(readme): change readme.md to new format
1 parent 291f0b4 commit 31ac08c

1 file changed

Lines changed: 195 additions & 60 deletions

File tree

README.md

Lines changed: 195 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,197 @@
1-
<h1 dir="rtl">پروگیت، ویرایش دوم</h1>
2-
<p dir="rtl">به ویرایش دوم کتاب پروگیت (گیت حرفه ای) خوش آمدید</p>
3-
<p dir="rtl">نسخه آنلاین این کتاب را <a href="http://git-scm.com/book/fa/v2" target="_blank">اینجا</a> ببینید.
4-
</p>
5-
<p dir="rtl">
6-
همانند ویرایش اول، ویرایش دوم پروگیت هم متن-باز تحت لایسنس «کریتیو کامنز» است. (Creative Commons)
7-
</p>
8-
<p dir="rtl">
9-
از زمان متن-باز شدن نسخه اول تغییراتی اعمال شده.
10-
ابتدا اینکه برای متن کتاب، ما از مارک‌دان به قالب شگفت‌انگیز اسکی‌داک مهاجرت کرده‌ایم. رفرنس سریع اسکی‌داک را می‌توانید در <a href="https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/">اینجا</a> پیدا کنید.
11-
</p>
12-
<p dir="rtl">
13-
ما، همچنین، انتقالی انجام دادیم تا ترجمه‌ها را در مخزن‌های جدایی به جای پوشه‌هایی در مخزن انگلیسی نگه‌داری کنیم.
14-
برای اطلاعات بیشتر به <a href="https://github.com/progit2-fa/progit2/blob/master/TRANSLATING.md">سند ترجمه</a> مراجعه کنید.
15-
</p>
16-
<h2 dir="rtl">چگونگی ساختن کتاب</h2>
17-
<p dir="rtl">
18-
شما می‌توانید فایل‌های این کتاب الکترونیک را به طور دستی با اسکی‌داکتر بسازید.
19-
اگر دستورات پیش‌رو را اجرا کنید احتمالاً می‌توانید خروجی‌های اچ‌تی‌ام‌ال، ای-پاب، موبی و پی‌دی‌اف بگیرید:
20-
</p>
21-
<pre>
1+
<div align="center">
2+
3+
# پروگیت، ویرایش دوم
4+
## ترجمه فارسی کتاب Pro Git
5+
6+
[![GitHub Issues](https://img.shields.io/github/issues/progit/progit2-fa)](https://github.com/progit/progit2-fa/issues)
7+
[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/progit/progit2-fa)](https://github.com/progit/progit2-fa/pulls)
8+
9+
</div>
10+
11+
<div dir="rtl">
12+
13+
## درباره این پروژه
14+
15+
به ویرایش دوم کتاب پروگیت (گیت حرفه‌ای) خوش آمدید. این مخزن حاوی ترجمه فارسی کامل کتاب Pro Git است که یکی از جامع‌ترین منابع آموزشی سیستم کنترل نسخه Git محسوب می‌شود.
16+
17+
**📖 [نسخه آنلاین کتاب را اینجا مطالعه کنید](http://git-scm.com/book/fa/v2)**
18+
19+
## ویژگی‌ها
20+
21+
- ✅ ترجمه کامل ویرایش دوم کتاب Pro Git
22+
- 📝 فرمت AsciiDoc برای قابلیت نگهداری بهتر
23+
- 🔄 به‌روزرسانی مداوم محتوا
24+
- 📱 پشتیبانی از خروجی‌های مختلف (HTML، PDF، EPUB، MOBI)
25+
- 🎯 تطبیق کامل با نسخه انگلیسی
26+
27+
## فهرست مطالب
28+
29+
- [نحوه ساخت کتاب](#چگونگی-ساختن-کتاب)
30+
- [گزارش مشکلات](#ارجاع-یک-مشکل)
31+
- [مشکلات شناخته شده](#مشکلات-شناخته-شده)
32+
- [نحوه مشارکت](#مشارکت)
33+
34+
## اطلاعات لایسنس
35+
36+
همانند ویرایش اول، ویرایش دوم پروگیت نیز متن‌باز تحت لایسنس [Creative Commons](LICENSE) منتشر شده است.
37+
38+
## تغییرات نسبت به ویرایش اول
39+
40+
- **فرمت جدید**: مهاجرت از Markdown به فرمت AsciiDoc
41+
- **مخزن جداگانه**: ترجمه‌ها در مخزن‌های مستقل نگهداری می‌شوند
42+
- **بهبود ساختار**: سازماندهی بهتر محتوا و فایل‌ها
43+
44+
[📋 راهنمای کامل ترجمه](https://github.com/progit/progit2-fa/blob/master/TRANSLATING.md)
45+
46+
</div>
47+
<div dir="rtl">
48+
49+
## چگونگی ساختن کتاب
50+
51+
### پیش‌نیازها
52+
53+
برای ساخت کتاب نیاز به ابزارهای زیر دارید:
54+
55+
- Ruby 2.7 یا بالاتر
56+
- Bundler gem
57+
- Git
58+
59+
### راهنمای سریع ساخت
60+
61+
```bash
62+
# نصب وابستگی‌ها
2263
$ bundle install
64+
65+
# ساخت تمام فرمت‌های کتاب
2366
$ bundle exec rake book:build
24-
Converting to HTML...
25-
-- HTML output at progit.html
26-
Converting to EPub...
27-
-- Epub output at progit.epub
28-
Converting to Mobi (kf8)...
29-
-- Mobi output at progit.mobi
30-
Converting to PDF...
31-
-- PDF output at progit.pdf
32-
</pre>
33-
<h1 dir="rtl">ارجاع یک مشکل</h1>
34-
<p dir="rtl">
35-
قبل از ارجاع یک مشکل، لطفاً بررسی کنید که پیشتر مشکل مشابهی در سیستم رهگیری باگ وجود نداشته باشد.
36-
</p><p dir="rtl">
37-
همچنین اگر این مشکل سابقاً روی سایت رسمی گیت مشاهده شده، لطفاً بازنگری کنید که آیا هنوز در این مخزن موجود است یا خیر.
38-
ممکن است پیش از این مشکل اصلاح شده باشد، اما تغییرات هنوز اعمال نشده باشند.
39-
</p>
40-
<h2 dir="rtl">مشکل فونت فارسی</h2>
41-
<p dir="rtl">
42-
در بعضی سیستم‌ها ممکن است خروجی پی‌دی‌اف خوانا نباشد و یا مشکلات قالبی (راست‌چین بودن) و... داشته باشد.
43-
پیشنهاد می‌شود که اسکی‌داکتر را بازتنظیم کنید و از فونت‌سازگار استفاده کنید.
44-
</p><p dir="rtl">
45-
با توجه به دشواری بازتنظیمی اسکی‌داکتر ممکن است بخواهید از خروجی اچ‌تی‌ام‌ال استفاده کرده یا در صورت نیاز به پی‌دی‌اف، خروجی اچ‌تی‌ام‌ال را توسط ابزاری مانند مرورگر به پی‌دی‌اف تبدیل کنید.
46-
</p>
47-
<h2 dir="rtl">ترجمهٔ ناقص</h2>
48-
<p dir="rtl">
49-
ممکن است ترجمه‌ها پیش‌نویس یا ناقص و یا کلمات یکپارچگی نداشته باشند. این امر ممکن است به دلایل مختلف (محدودیت‌های فنی) اتفاق افتاده باشد. اگر چنین موردی مشاهده کردید و در تودو ذکر نشده بود یا برای
50-
آن ایشوی نظیری وجود نداشت یا آنرا حل کرده و پول ریکوئست درست کنید و یا در ایشوهای به ما یادآوری کنید تا در اسرع وقت آنرا پیگیری کنیم.
51-
</p><p dir="rtl">
52-
به طور کل فایل‌های بالای ۸۰ درصد در فایل استاتوس.جی‌سان کامل تلقی می‌شوند.
53-
فایل‌های ۹۵ درصد ترجمهٔ نهایی شده‌اند و نیازمند بازبینی هستند و فایل‌های ۹۰ درصد پیش‌نویس نهایی هستند.
54-
</p>
55-
<h2 dir="rtl">لینک‌های انگلیسی یا ناقص</h2>
56-
<p dir="rtl">
57-
ترجمهٔ لینک‌ها و اتصال آنها کار دشواری است. به همین دلیل این کار در مراحل آخر اصلاح خواهد شد. لطفاً شکیبا باشید.
58-
</p>
59-
<h1 dir="rtl">مشارکت</h1>
60-
<p dir="rtl">
61-
اگر مایلید کمک کنید تا تغییری ایجاد شود، لطفاً به <a href="https://github.com/progit2-fa/progit2/blob/master/CONTRIBUTING.md">راهنمای مشارکت در پروژه</a> مراجعه کنید.
62-
</p>
67+
```
68+
69+
### خروجی‌های تولید شده
70+
71+
پس از اجرای دستورات بالا، فایل‌های زیر تولید خواهند شد:
72+
73+
| فرمت | نام فایل | توضیحات |
74+
|------|----------|---------|
75+
| HTML | `progit.html` | نسخه وب کتاب |
76+
| EPUB | `progit.epub` | مناسب برای e-reader ها |
77+
| MOBI | `progit.mobi` | سازگار با Kindle |
78+
| PDF | `progit.pdf` | نسخه قابل چاپ |
79+
80+
### ساخت فرمت خاص
81+
82+
```bash
83+
# فقط HTML
84+
$ bundle exec rake book:build_html
85+
86+
# فقط PDF
87+
$ bundle exec rake book:build_pdf
88+
89+
# فقط EPUB
90+
$ bundle exec rake book:build_epub
91+
```
92+
93+
</div>
94+
<div dir="rtl">
95+
96+
## گزارش مشکلات
97+
98+
### قبل از گزارش مشکل
99+
100+
قبل از ثبت مشکل جدید، لطفاً موارد زیر را بررسی کنید:
101+
102+
1. **جستجو در مسائل موجود**: ممکن است مشکل شما قبلاً گزارش شده باشد
103+
2. **بررسی سایت اصلی Git**: اگر مشکل روی [git-scm.com](https://git-scm.com/book/en/v2) حل شده، ممکن است در حال به‌روزرسانی باشد
104+
3. **وضعیت ترجمه**: وضعیت فعلی ترجمه را در فایل `status.json` بررسی کنید
105+
106+
### نحوه گزارش مشکل
107+
108+
برای گزارش مشکل:
109+
110+
1. به [صفحه Issues](https://github.com/progit/progit2-fa/issues) بروید
111+
2. روی "New Issue" کلیک کنید
112+
3. عنوان توصیفی و جزئیات کامل ارائه دهید
113+
4. اگر امکان دارد، راه‌حل پیشنهادی ارائه دهید
114+
115+
## مشکلات شناخته شده
116+
117+
### مشکل فونت فارسی در PDF
118+
119+
**علت**: برخی سیستم‌ها فونت‌های فارسی را به درستی پردازش نمی‌کنند
120+
121+
**راه‌حل‌های پیشنهادی**:
122+
- استفاده از خروجی HTML به جای PDF
123+
- تبدیل HTML به PDF از طریق مرورگر
124+
- بازتنظیم AsciiDoctor با فونت‌های سازگار
125+
126+
### ترجمه ناقص
127+
128+
**وضعیت فایل‌ها بر اساس درصد تکمیل**:
129+
130+
| درصد تکمیل | وضعیت | توضیحات |
131+
|------------|--------|---------|
132+
| 95%+ | نهایی | نیازمند بازبینی نهایی |
133+
| 90-94% | پیش‌نویس نهایی | آماده برای بازبینی |
134+
| 80-89% | کامل | محتوای اصلی تکمیل شده |
135+
| <80% | در حال کار | نیازمند تکمیل |
136+
137+
### لینک‌های انگلیسی
138+
139+
ترجمه و بومی‌سازی لینک‌ها در مراحل پایانی پروژه انجام خواهد شد.
140+
141+
</div>
142+
<div dir="rtl">
143+
144+
## مشارکت
145+
146+
ما از تمام کمک‌ها استقبال می‌کنیم! برای مشارکت در این پروژه روش‌های مختلفی وجود دارد:
147+
148+
### انواع مشارکت
149+
150+
#### 🔤 ترجمه
151+
- ترجمه فصل‌های جدید
152+
- بهبود ترجمه‌های موجود
153+
- اصلاح اشتباهات املایی و نگارشی
154+
155+
#### 📝 بازبینی
156+
- بررسی متن‌های ترجمه شده
157+
- پیشنهاد بهبود در کیفیت ترجمه
158+
- هماهنگی اصطلاحات فنی
159+
160+
#### 🐛 رفع مشکلات
161+
- گزارش اشکالات
162+
- رفع مشکلات فنی
163+
- بهبود فرآیند ساخت
164+
165+
### شروع مشارکت
166+
167+
1. **Fork** کردن مخزن
168+
2. ایجاد شاخه جدید برای تغییرات:
169+
```bash
170+
git checkout -b feature/my-contribution
171+
```
172+
3. اعمال تغییرات و commit
173+
4. Push به مخزن fork شده
174+
5. ایجاد Pull Request
175+
176+
### راهنماهای مفصل
177+
178+
- 📖 [راهنمای کامل مشارکت](https://github.com/progit/progit2-fa/blob/master/CONTRIBUTING.md)
179+
- 🌐 [راهنمای ترجمه](https://github.com/progit/progit2-fa/blob/master/TRANSLATING.md)
180+
181+
### ارتباط با تیم
182+
183+
برای سوالات و پیشنهادات:
184+
- [GitHub Issues](https://github.com/progit/progit2-fa/issues)
185+
- [GitHub Discussions](https://github.com/progit/progit2-fa/discussions)
186+
187+
---
188+
189+
<div align="center">
190+
191+
**با تشکر از همه مشارکت‌کنندگان** 🙏
192+
193+
[مشاهده تمام مشارکت‌کنندگان](https://github.com/progit/progit2-fa/graphs/contributors)
194+
195+
</div>
196+
197+
</div>

0 commit comments

Comments
 (0)