logo

计算机入门

Introduction to Computer Science

Mac 开发配置手册

Mac OS 设置指南

Windows 设置指南

怎样写一个好的ReadMe

The Ultimate Guide to Writing a Great README.md for Your Project

HTML&CSS

HTML&CSS Part1

lock status

HTML&CSS Part2

lock status

HTML&CSS Part3

lock status

HTML&CSS tutorial

Git入门

如何安装Git

lock status

Git基础知识

lock status

Git高级用法

Javascript

Javascript Part1

lock status

Javascript Part2

lock status

Javascript Part3

lock status

Javascript tutorial 1

lock status

Javascript tutorial 2

Nodejs

Nodejs Part1

lock status

Nodejs Part2

lock status

Nodejs Part3

lock status

Nodejs Part4

lock status

Nodejs Part5

lock status

Nodejs tutorial 1

lock status

Nodejs tutarial 2

Database

Database

Database tutorial

Python

Python Part1

Python Part2

lock status

Python Part3

lock status

Python Part4

lock status

Python Part5

lock status

Python Part6

lock status

Python Part7

lock status

Python Part8

Final Project

Backend 1

lock status

Backend 2

Frontend 1

Frontend 2

lock status

Frontend 3

Hackathon

Web3 & AI Hackfest

back返回
setting

怎样写一个好的ReadMe

Your documentation is a direct reflection of your software, so hold it to the same standards.
After much practice, I have a recipe of sorts for writing READMEs that I follow anytime I make a new project. I wanted to share my process here, gather feedback, and see if I can lower the barrier to writing a good README.
本章目录
    logo

    Follow Us

    linkedinfacebooktwitterinstagramweiboyoutubebilibilitiktokxigua

    We Accept

    /image/layout/pay-paypal.png/image/layout/pay-visa.png/image/layout/pay-master-card.png/image/layout/pay-airwallex.png/image/layout/pay-alipay.png

    关于公司

    关于我们元宇宙课堂新闻资讯匠人工作成为导师匠人导师联系我们匠人商店J3.Club

    匠人资源

    工作内推匠人活动1对1私教行业白皮书线上学习平台分享面试经验Internship

    大学资源

    墨尔本大学昆士兰大学新南威尔士大学悉尼大学莫那什大学阿德莱德大学RMITQUTUTS

    企业合作

    企业培训实习合作招聘合作申请合作

    匠人支持

    FAQsTerms & ConditionsPrivacy PolicyCancellation & Refund PolicySite map

    Top Categories

    Web全栈班DevOps项目班数据工程全栈班数据分析项目班编程入门班Business Analyst实习算法集训营

    求职就业

    BA和产品经理实习数据科学实习数据分析实习Marketing实习简历修改面试指导导师指导VIP

    地址

    Level 10b, 144 Edward Street, Brisbane CBD(Headquarter)
    Level 2, 171 La Trobe St, Melbourne VIC 3000
    四川省成都市武侯区桂溪街道天府大道中段500号D5东方希望天祥广场B座45A13号
    Business Hub, 155 Waymouth St, Adelaide SA 5000

    联系方式

    hello@jiangren.com.au0421-672-555

    Disclaimer

    footer-disclaimerfooter-disclaimer

    JR Academy acknowledges Traditional Owners of Country throughout Australia and recognises the continuing connection to lands, waters and communities. We pay our respect to Aboriginal and Torres Strait Islander cultures; and to Elders past and present. Aboriginal and Torres Strait Islander peoples should be aware that this website may contain images or names of people who have since passed away.

    匠人学院网站上的所有内容，包括课程材料、徽标和匠人学院网站上提供的信息，均受澳大利亚政府知识产权法的保护。严禁未经授权使用、销售、分发、复制或修改。违规行为可能会导致法律诉讼。通过访问我们的网站，您同意尊重我们的知识产权。 JR Academy Pty Ltd 保留所有权利，包括专利、商标和版权。任何侵权行为都将受到法律追究。查看用户协议

    © 2017-2024 JR Academy Pty Ltd. All rights reserved.

    ABN 26621887572