Read My README

Read-My-Readme

เทมเพลต ReadMe ที่เป็นระเบียบและขัดเงาสำหรับโครงการของคุณ!
ภาพหน้าจอ·ข้อกำหนด·สถาปัตยกรรม·เทคโนโลยี·ใบอนุญาต

Read-My-ReadMe เป็นเทมเพลต ReadMe ที่เป็นระเบียบอย่างง่ายขึ้นอยู่กับ ตัวพิมพ์ที่ดีที่สุด

เดิมทีได้รับการปรับแต่งให้ใช้ในโครงการมือถือ แต่สามารถปรับแต่งได้ง่ายเพื่อให้พอดีกับกรณีการใช้งานอื่น ๆ

ยังรู้สึกไม่ได้รับความสนใจ? นี่คือตัวอย่างบางส่วนที่ใช้สไตล์ readme นี้กับการปรับแต่งบางอย่าง:

• Xpensor : ตัวติดตามค่าใช้จ่าย Android ในท้องถิ่น
• Launchpad : แอพเกี่ยวกับกิจกรรมอวกาศ
• ผู้รักษาประตู : แอพกาตาร์ 2022

? ui/ux? ️

ส่วนนี้เป็นเรื่องเกี่ยวกับรายละเอียด UI/UX ของโครงการธีมและภาพเคลื่อนไหวของพวกเขา

ภาพเคลื่อนไหวและเนื้อหาแบบโต้ตอบจากส่วนนี้ควรวางไว้ใน readme-assets/gifs

ภาพเคลื่อนไหว 1	ภาพเคลื่อนไหว 2	ภาพเคลื่อนไหว 3	ภาพเคลื่อนไหว 4

(กลับไปด้านบน)

- ภาพหน้าจอ?

ที่นี่คุณสามารถเพิ่มภาพหน้าจอของโครงการของคุณอ้างอิงระบบการออกแบบที่ใช้ (วัสดุ / คูเปอร์ติโน / กำหนดเอง) และโหมด UI ที่แตกต่างกัน (กลางคืน / มืด)

ภาพหน้าจอจากส่วนนี้ควรวางไว้ใน readme-assets/images

หน้าจอ 1	หน้าจอ 2	หน้าจอ 3

หน้าจอ 4	หน้าจอ 5	หน้าจอ 6

(กลับไปด้านบน)

ความต้องการ

ที่นี่คุณสามารถให้คำแนะนำเกี่ยวกับวิธีการตั้งค่าโครงการของคุณในเครื่อง: การติดตั้ง, ปุ่ม API ฯลฯ

1. รับคีย์ API ฟรีที่ https://example.com
2. โคลน repo

git clone https://github.com/your_username_/Project-Name.git 

3. ติดตั้งแพ็คเกจ NPM

npm install

ป้อน API ของคุณใน config.js

 const API_KEY = 'ENTER YOUR API' ;

(กลับไปด้านบน)

- สถาปัตยกรรม ?

ส่วนนี้ควรแสดงความคิดเห็นสถาปัตยกรรมที่ใช้ในโครงการ

(กลับไปด้านบน)

- เทคโนโลยี?

ส่วนนี้ควรแสดงรายการเฟรมเวิร์ก/ไลบรารีที่สำคัญใด ๆ ที่ใช้ในการ bootstrap โครงการของคุณ

(กลับไปด้านบน)

- ผู้แต่ง?

ชื่อของคุณ - @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.

(กลับไปด้านบน)