【工具推荐】最简单方法创建 README

2024-04-29 12:42:19

CSDN话题挑战赛第1期

活动详情地址：https://marketing.csdn.net/p/bb5081d88a77db8d6ef45bb7b6ef3d7f

参赛话题：程序员常用小工具推荐

话题描述：俗话说，工欲善其事，必先利其器。作为每天和各种开发工具打交道的程序员，想必各位都有几件趁手的兵器吧！欢迎你和大家一起分享自己常用的小工具。小工具可以是命令行工具，也可以是项目内的组件、小而美的网站。希望你和大家一起分享~

创作模板：

一、简介

名称：readme.so

类型：网站

官网地址：https://readme.so/cn

便捷提示一个优秀的readme文件的工具，小而美的网站。

二、解决的问题

在项目的根目录，我们通常都会编写readme文件，来告诉大家项目是做什么的。

某种程度上讲，在Github上，拥有完整的readme，是实验项目和成熟项目的最明显的区别。

而这个网站，就可以帮助我们完成一份完整的readme文件。

三、使用说明

1. 进入网站

进去网站，可以选择各种语言，这里我们选择中文简体。

工具类文本不多的网站建议大家都做一下国际化（I18N），用起来很舒服。

2. 组件选择

编辑器地址为 https://readme.so/editor ，点击起步按钮也是一样。

我们可以看到编辑器分为三个部分。

这个可以说是这个网站的核心，他告诉了我们readme组成的都会有哪些部分。

3. 编辑器 & 预览

中间这部分就是md编辑器了。

有意思的是，点击组件之后，默认会有如何写好readme的链接，可以说是很贴心了。

最右侧则是实时预览和源文件展示，支持一键复制。

4. 导出按钮

页面右上角是导出按钮，我们可以直接下载编辑好的readme文档。

左边是夜间模式。

四、缺点和不足

作为小而美的工具网站，可以说没啥缺点。

五、总结

对于readme编写不熟练的开发者来说，这个工具非常不错，建议加入收藏夹。

CSDN话题挑战赛第1期

活动详情地址：https://marketing.csdn.net/p/bb5081d88a77db8d6ef45bb7b6ef3d7f

【工具推荐】最简单方法创建 README相关推荐

【Windows 逆向】CheatEngine 工具 ( 汉化版 CE 工具推荐 | 编写简单 C++ 程序 | C++ 程序执行分析 | 使用 CE 修改上述 C++ 程序 )
文章目录一.汉化版 CE 工具推荐二.编写简单 C++ 程序三.C++ 程序执行分析四.使用 CE 修改上述 C++ 程序一.汉化版 CE 工具推荐推荐一个汉化版的 CE 工具 : htt ...
Sqlite可视化工具推荐(附简单使用方法)
1.sqlite database browser 功能较少,简单易用.常用功能:编辑表.编辑列(field).编辑行(record).编辑单元格, 创建列时,可是设置列类型为主键自增另外,还可以在 ...
怎么pdf转cad？推荐这个简单方法，一键转换多个文件
近期有些小伙伴求助说,自己学的是土木专业,经常会使用CAD工具来进行绘图设计,之后为了提升能力,时常会与同学.老师之间互发图纸进行学术交流,而他人为了确保对方查看文档时排版不错乱,都会选择以PDF格式 ...
pdf分割的工具使用的简单方法
对于电脑新手来说,当遇到一个较大的PDF文件,不知道该怎么将之分割成两个文件,或者多页的连续的pdf文件如何拆分成单张单张的pdf文件?,下面跟着小仙一起去看看吧! 方法/步骤 ①首先,我们确保自己 ...
生产力工具推荐，思维导图测评 #CSDN博文精选##思维导图##系统化学习#
大家好~我是小C,全名是CSDN高校俱乐部,我的职责之一是担任"文章过滤器",精选大咖干货.助力学习之路. 你是否曾面对海量信息而无从下手? 你是否曾苦恼学习效果不佳.事倍功半? ...
ubuntu 15个最佳的屏幕录制工具推荐
前言屏幕播放对于许多人来说是一项重要任务,原因很多,包括制作视频教程,创建演示文稿,编写操作指南或进行软件评审,或者在玩PC游戏时享受流媒体的乐趣. 此外,现在有很多用户通过YouTube,Face ...
PDF可以转PPT吗？PDF转PPT简单方法推荐
PDF转PPT简单方法推荐!网上有很多PDF转PPT的方法推荐,但是你们都试过了吗?能正常转换的究竟有多少?今天我也给大家推荐一款PDF转PPT的最简单实用的PDF工具"金闪PDF" ...
干货分享丨如何创建在线培训手册的五大步骤，附带工具推荐。
每个企业/团队都需要创建培训手册.并且需要创建多个手册来满足内部和外部培训需求. 在内部,培训手册可帮助所有员工在工作过程中保持高效和高产. 在外部,培训手册是客户教育,为用户普及产品使用过程中的方方 ...
6款数据库管理工具推荐，设计简单、功能丰富，还与阿里云兼容哦！
说到Navicat,相信大家对它都不陌生.Navicat是一套快速.可靠.功能全面且价格便宜的数据库管理工具,专为简化数据库管理及降低系统管理成本而设.使用过Navicat 产品的朋友应该知道,其设计 ...

最新文章

热门文章