awesome-labs/iOS-readme-template
این یک الگوی آماده برای فایل README.md در پروژه‌های منبع باز iOS است.
کاربرد:
این الگو به تو کمک می‌کنه تا یک فایل مستندات حرفه‌ای و کامل برای پروژه‌های iOS خودت ایجاد کنی، بدون اینکه از صفر شروع کنی.
در چه شرایطی بهتره استفاده شود؟
وقتی داری یک کتابخانه یا ابزار open-source برای پلتفرم iOS منتشر می‌کنی و می‌خوای مستنداتش تمیز، خوانا و جذاب باشه.
چند مثال از موارد استفاده:
مستندسازی یک کتابخانه Swift برای مدیریت API
معرفی یک کامپوننت UI قابل استفاده مجدد
راهنمای نصب و استفاده از یک فریم‌ورک جدید
- ##iOS
- ##Swift
- ##OpenSource
- ##README
- ##MobileDev
- ##Xcode
- ##Apple
- ##Developer
- ##CodeDocument
- ##Template