如何为项目编写良好 README (quickapp.lovejade.cn)

【简介】

README,它是别人对项目了解、印象的第一来源;尤其是针对开源项目,相当之重要:好比颜值之于一个人,主页之于一个公司;但很多项目并未重视这一点;各种仓库,浩如烟海,没有简洁、明晰的介绍,教人如何耐心去看?本篇文章的存在,即是为了改善这种情况。它将指导您如何写出一篇友好、易读的 README ,同时提供一键生成专业 README(模版)的工具,从而为广大开发者,解决如何书写良好 README 之烦忧;同时为诸多阅读者,缓解没有清晰 README 一窥项目主旨的苦恼。

点击查看全文 >>

@杨琼璞 2020-01-16 20:59分享 / 0个评论
赞过的人: 技术头条 IT技术博客大学习 杨琼璞
要不要再学学下面的文章?
Flutter 添加到现有项目 (mp.weixin.qq.com)
最近一直在看Flutter 的内容, 加上近期更新的Flutter1.12 有一些Flutter 的api 发生了改变, 所以 某些和android 交互的地方 就发生了变化
by @code小生 2020-05-18 13:36 分享 查看详情
编写高性能 Java 代码的最佳实践 (mp.weixin.qq.com)
本文首先介绍了负载测试、基于APM工具的应用程序和服务器监控,随后介绍了编写高性能Java代码的一些最佳实践。最后研究了JVM特定的调优技巧、数据库端的优化和架构方面的调整。
by @code小生 2020-05-18 13:35 分享 查看详情
7 个开源的 Spring Boot 前后端分离项目,一定要收藏! (mp.weixin.qq.com)
前后端分离已经在慢慢走进各公司的技术栈,根据松哥了解到的消息,不少公司都已经切换到这个技术栈上面了。即使贵司目前没有切换到这个技术栈上面,松哥也非常建议大家学习一下前后端分离开发,以免在公司干了两三年,SSH 框架用的滚瓜烂熟,出来却发现自己依然没有任何优势!
by @code小生 2020-05-11 14:12 分享 查看详情
前端项目开发规范意见 (www.jeffjade.com)
出于整个团队代码可读性、可维护性考量,有必要约定一套基本规范(包括代码命名、基础设施、提交日志、对外文档、测试等方面),供各团队都能参考,从而提升项目可持续性发展,也便于成员之间,能很好提升代码 CoverReview 效率等。鉴于此,有将近些年积淀的些许经验,整理成文,希望可以为追求“高效”工作的朋友们,带来一些参考性意见。
by @杨琼璞 2020-05-06 13:41 分享 查看详情
Github 上最热门的 Java 开源项目 (mp.weixin.qq.com)
10 月份 GitHub 上最热门的Java开源项目排行已经出炉啦,在本月的名单中,实战项目类居多,当然也有像JavaGuide这样学习指南类项目,下面就是本月上榜的10个开源项目:
by @code小生 2020-04-26 20:03 分享 查看详情
记录项目升级 AndroidX+API29 的各种坑 (mp.weixin.qq.com)
年前的时候,公司为了业务发展,签署了一个第三方的代码库,需要我们集成,然后这个项目是依赖于androidX和各种各样新库.所以为了集成该项目,我们强制升级了我们的gradle,依赖库,目标api版本.我们的项目一直使用API27作为target和build的版本,所以在前期利用api版本避免了很多坑,自从集成了这个项目,噩梦开始了
by @code小生 2020-04-26 20:01 分享 查看详情
在对比了 GitHub 5000 个 Python 项目之后,我们精选出了这 36 个! (mp.weixin.qq.com)
去年,国外一位热衷于为开发者提供优质项目的开发者 Mybridge 为大家精送了一份优秀 Python 开源项目推荐。
by @code小生 2020-04-19 18:34 分享 查看详情
10分钟用 Python 编写一个贪吃蛇小游戏 (mp.weixin.qq.com)
贪吃蛇,大家应该都玩过。当初第一次接触贪吃蛇的时候 ,还是能砸核桃的诺基亚上,当时玩的不亦乐乎。今天,我们用Python编程一个贪吃蛇游戏,下面我们先看看效果:
by @code小生 2020-04-15 19:10 分享 查看详情
推荐 13 个 Python 新手练级项目 (mp.weixin.qq.com)
该项目设计的主要目标是聚合内容。首先,我们需要知道内容聚合器从哪些站点获取内容。然后,使用请求库来发送 HTTP 请求,并使用 BeautifulSoup 解析和抓取站点的必要内容。
by @code小生 2020-04-15 19:09 分享 查看详情
火爆全网!这个项目很骚气! (mp.weixin.qq.com)
像文字云一样,用各种小图拼出大的图片,构建一个像素风的世界,就像《我的世界》里一样,一定非常有趣。
by @code小生 2020-04-06 21:29 分享 查看详情