یک قالب عالی برای شروع پروژه های خود !
ویکی را بررسی کنید »
نسخه نمایشی را ببینید
·
یک باگ را گزارش کنید
·
یک قابلیت را درخواست کنید
فهرست
تعداد زیادی قالب های ریدمی عالی در گیتهاب وجود دارد. اما من نتوانستم قالبی پیدا کنم که مناسب پروژه های من باشد، پس من این قالب بهبود یافته را ساختم. من همیشه میخواستم قالبی که میسازم، آخرین قالبی باشد که نیاز دارید و من فکر میکنم این قالب همان است.
دلایل:
- زمان شما باید صرف ساختن چیز های عالی بشود. یک پروژه که به بقیه کمک کند.
- شما نباید زمان خود را صرف انجام کار های تکراری مانند ساختن ریدمی کنید.
- شما باید از اصول DRY در کل زندگی خود استفاده کنید 😄
قطعا هیچ قالبی به تنهایی نمیتواند نیاز تمامی پروژه ها را برطرف کند. به همین خاطر من قالب های بیشتری در آینده اضافه خواهم کرد. شما همچنین میتوانید توسط فورک کردن پروژه و ایجاد کردن پول ریکوئست و یا شروع کردن یک موضوع قابلیت های جدید پیشنهاد کنید. با تشکر از تمامی افرادی که حمایت کردند.
برای شروع از فایل BLANK_README.md استفاده کنید.
(بازگشت)
در این بخش تمامی فریمورک ها و کتابخانه هایی که استفاده شده را لیست کنید. اد آن ها و پلاگین ها را در بخش "منابع" لیست کنید. مثال :
این یک مثال است از نحوه ای که مخاطب میتواند پروژه را به صورت محلی نصب کند. برای داشتن یک کپی ساده از پروژه این مراحل ساده را دنبال کنید.
این یک مثال است از تمام چیز هایی که باید نصب کنید و نحوه نصب آنها .
- npm
npm install npm@latest -g
در بخش زیر میتوانید مخاطبان خود را برای نصب پروژه راهنمایی کنید. این قالب از هیچ سرویس خارجی استفاده نمیکند.
- یک کلید API رایگان دریافت کنید https://example.com
- ریپازیتوری را کپی کنید
git clone https://github.com/your_username_/Project-Name.git
- پکیج های npm را نصب کنید
npm install
- کلید API خود را در
config.jsوارد کنید.const API_KEY = 'ENTER YOUR API';
از این فضا برای نشان دادن نحوه های استفاده از پروژه استفاده کنید. اسکرین شات های بیشتر، بخش هایی از کد و نسخه نمایشی مناسب این بخش هستند. اینجا میتوانید منابع را لیست کنید.
برای مثال های بیشتر به ویکی مراجعه کنید
- اضافه کردن بخش تغییرات
- "اضافه کردن لینک های "بازگشت به بالا بب- [ ] ساختن قالب های بیشتر با مثال
- یک سند "components" برای کپی و پیست ساده تر ریدمی
- حمایت از زبان های مختلف
- چینی
- اسپانیایی
به اینجا برای لیست قابلیت های اضافه شده و مشکلاتی که وجود دارد مراجعه کنید.
به خاطر همکاری هاست که پروژه های اوپن-سورس یک فضای عالی برای یادگیری، اثر گذاری و ساختن هستند. از همه همکاری هایی که میکنید بسیار قدردانی میکنم.
که فکر میکنید باعث بهتر شدن پروژه میشود، لطفا ریپازیتوری را فورک کنید و یک پل ریکوئست ایجاد کنید یا برای فرایند ساده تر یک موضوع با تگ "بهتر سازی" ایجاد کنید.
- پروژه را فورک کنید
- یک شاخه به نام feature بسازید (
git checkout -b feature/AmazingFeature) - تغییراتتان را ایجاد کنید (
git commit -m 'Add some AmazingFeature') - به شاخه اصلی پوش کنید (
git push origin feature/AmazingFeature) - یک پل ریکوئست ایجاد کنید.
این پروژه تحت لایسنس MIT است. برای اطلاعات بیشتر به فایل LICENSE.txt مراجعه کنید.
نام شما - @your_twitter - email@example.com
لینک پروژه: https://github.com/your_username/repo_name
از این فضا برای لیست کردن منابعی که از آن استفاده کردید ، استفاده کنید. من چند تا از منابع مورد علاقه ام را لیست کردم !