如何写出优雅且有意义的 README.md #6671
如何写出优雅且有意义的 README.md #6671
Conversation
如何写出优雅且有意义的 README.md
|
这也太快了.jpg |
|
校对认领 |
|
@vitoxli 好的呢 🍺 |
|
校对认领 |
|
@Starry316 妥妥哒 🍻 |
|
|
||
| We, developers, are very good with code and all the minute details of our projects. But some of us (me included) lack in soft-skills even in the online community. | ||
| 作为开发人员，我们对代码以及项目中的所有细节都信手拈来。然而我们中的一些人（包括我在内）就连在网络社区中都缺乏着软技能。 |
There was a problem hiding this comment.
然而我们中的一些人（包括我在内）就连在网络社区中都缺乏着软技能。 => 然而我们中的一些人（包括我在内）甚至缺乏着在网络社区中的软技能。
|
|
||
| README (as the name suggests: “read me”) is the first file one should read when starting a new project. It’s a set of useful information about a project and a kind of manual. It is the first file Github or any Git hosting site will show when someone opens your repository.. | ||
| README（顾名思义：“read me“）是启动新项目时应该阅读的第一个文件。它既包含了一系列关于项目的有用信息又是一个项目的手册。它是别人在 Github 或任何 Git 托管网站点，开你仓库时看到的第一个文件。 |
There was a problem hiding this comment.
开你仓库时看到的第一个文件。 => 打开你仓库时看到的第一个文件。
|
|
||
| And the`.md`extension comes from a word: **markdown**. It's a markup language for text formatting. Just like HTML it is a markup language to make our documents presentable. | ||
| `.md` 这个文件后缀名来自于单词：**markdown**。它是一种用于文本格式化的标记语言。就像 HTML 一样，使我们的文档可呈现的标记语言。 |
There was a problem hiding this comment.
就像 HTML 一样，使我们的文档可呈现的标记语言。 => 就像 HTML 一样，可以优雅地展示我们的文档。
presentable 感觉可以翻译成得体的，仅供参考
|
|
||
| ## Why spend time on your Readme? | ||
| ## 为什么要花时间在 Readme 上？ |
There was a problem hiding this comment.
为什么要花时间在 Readme 上？ => 为什么要在 Readme 上花时间？
|
|
||
| Now let’s talk business. You spent hours on a project, you made it public on GitHub and you want people/recruiters/colleagues/(Ex?) see your project. Do you really think they would go into `root/src/app/main.js` to view that beautiful logic of yours? Seriously? | ||
| 现在我们谈正事吧。你花了几个小时在一个项目上，你在 GitHub 上发布了它，并且你希望游客、招聘人员、同事、（或者前任？）看到这个项目。您真的认为他们会进入 `root/src/app/main.js` 来查看你的代码的逻辑吗？真的会吗？ |
There was a problem hiding this comment.
您真的认为 => 你真的认为
全文的 您 和 你 可以考虑保持一致
| * 标题（如果可以的话，提供标题图像。如果你不是平面设计师，请在 canva.com 上进行编辑）。 | ||
| * 描述（用文字和图片来描述）。 | ||
| * Demo（图片、视频链接、在线演示 Demo 链接)。 | ||
| * 使用的技术栈。 |
|
|
||
| We, developers, are very good with code and all the minute details of our projects. But some of us (me included) lack in soft-skills even in the online community. | ||
| 作为开发人员，我们对代码以及项目中的所有细节都信手拈来。然而我们中的一些人（包括我在内）就连在网络社区中都缺乏着软技能。 |
There was a problem hiding this comment.
『就连在网络社区中都缺乏着软技能。』=>『就连在网络社区中的软技能都缺乏。』
|
|
||
| README (as the name suggests: “read me”) is the first file one should read when starting a new project. It’s a set of useful information about a project and a kind of manual. It is the first file Github or any Git hosting site will show when someone opens your repository.. | ||
| README（顾名思义：“read me“）是启动新项目时应该阅读的第一个文件。它既包含了一系列关于项目的有用信息又是一个项目的手册。它是别人在 Github 或任何 Git 托管网站点，开你仓库时看到的第一个文件。 |
There was a problem hiding this comment.
『开你仓库时看到的第一个文件。』=>『打开你仓库时看到的第一个文件。』
|
|
||
| Yes, you can use HTML inside. Not all the features though. But most of it. Although you should stick to markdown only but, some features like centring images and text in the readme is only possible by HTML. | ||
| 是的，你可以在 Readme 里使用 HTML。但并不是 HTML 里所有的功能都可以使用，但大部分可以。虽然你最好是只包含 markdown 的语法，但一些功能，如居中图像和居中文本是只能用 HTML 实现的。 |
There was a problem hiding this comment.
『但并不是 HTML 里所有的功能都可以使用，但大部分可以。』=>『尽管并不是 HTML 里所有的功能都可以使用，但大部分可以。』
|
感谢校对，都已经做出修改了～辛苦 @vitoxli @Starry316 |
|
@lsvih 辛苦管理员审核下啦 |
|
@cyz980908 已经 merge 啦~ 快快麻溜发布到掘金然后给我发下链接，方便及时添加积分哟。 掘金翻译计划有自己的知乎专栏，你也可以投稿哈，推荐使用一个好用的插件。 |
|
不确定中间那个 gif 图在掘金发布的时候会不会出问题。最好发完检查一下，有问题把这个广告删了算了。。 |
|
如何写出优雅且有意义的 README.md
译文翻译完成，resolve #6670