الصفحة الرئيسية>المتعلقة بالبرمجة>شفرة المصدر الأخرى
تنزيل


شعار

read-my-readme

قالب ReadMe مرتبة ومصقول لمشاريعك!
لقطات الشاشة · المتطلبات · الهندسة المعمارية · التقنيات · ترخيص

Read-My-README هو قالب README SIMPLE SIMPLED بشكل فضفاض يعتمد على أفضل القراءة .

تم تصميمه في الأصل لاستخدامه في مشاريع الهاتف المحمول ، ولكن يمكن تخصيصه بسهولة لتناسب حالات الاستخدام المختلفة الأخرى.

ما زلت تشعر بأنها غير ملهمة؟ فيما يلي بعض العينات التي تستخدم أسلوب ReadMe هذه مع بعض التخصيصات:

  • Xpensor : A Local Android Expense Tracker
  • Launchpad : تطبيق حول أحداث الفضاء
  • حارس المرمى : تطبيق قطر 2022

؟ ️ ui/ux؟ ️

هذا القسم يدور حول تفصيل واجهة المستخدم/UX لمشروعك وموضوعاتهم والرسوم المتحركة.

يجب وضع الرسوم المتحركة والمحتوى التفاعلي من هذا القسم داخل readme-assets/gifs .

الرسوم المتحركة 1 الرسوم المتحركة 2 الرسوم المتحركة 3 الرسوم المتحركة 4

(العودة إلى الأعلى)

؟ لقطات الشاشة؟

يمكنك هنا إضافة لقطات شاشة مشاريعك ، والرجوع إلى نظام التصميم المستخدم (Material / Cupertino / Custom) وأنماط واجهة المستخدم المختلفة (الليل / الظلام).

يجب وضع لقطات الشاشة من هذا القسم داخل readme-assets/images

شاشة 1 شاشة 2 الشاشة 3
الشاشة 4 شاشة 5 الشاشة 6

(العودة إلى الأعلى)

متطلبات

هنا يمكنك تقديم إرشادات حول كيفية إعداد مشروعك محليًا: التثبيت ، مفاتيح API ، إلخ.

  1. احصل على مفتاح API مجاني على https://example.com
  2. استنساخ الريبو 
git clone https://github.com/your_username_/Project-Name.git
  1. تثبيت حزم NPM 
npm install

أدخل واجهة برمجة التطبيقات الخاصة بك في config.js 

 const API_KEY = 'ENTER YOUR API' ;

(العودة إلى الأعلى)

؟ بنيان ؟

يجب أن يعلق هذا القسم على الهندسة المعمارية المستخدمة في المشروع.

(العودة إلى الأعلى)

؟ التقنيات؟

يجب أن يسرد هذا القسم أي أطر عمل/مكتبات رئيسية تستخدم لتمهيد مشروعك.

(العودة إلى الأعلى)

؟ مؤلف (ق)؟

اسمك - twitter_usernamme - [email protected]

ملاحظة: إذا كان هناك العديد من المساهمين ، فقد تفكر في استخدام:

  • قائمة المساهمين
  • contrib.rocks

(العودة إلى الأعلى)

رخصة 

 MIT License

Copyright (c) 2023 Jonathan Areas

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

(العودة إلى الأعلى)

يوسع
معلومات إضافية
تطبيقات ذات صلة
نوصي لك
أخبار ذات صلة الكل