Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

文档格式太乱了,可读性很差 #20

Open
maxhis opened this issue May 13, 2017 · 0 comments
Open

文档格式太乱了,可读性很差 #20

maxhis opened this issue May 13, 2017 · 0 comments

Comments

@maxhis
Copy link

maxhis commented May 13, 2017

原谅我提了一个和技术本身无关的issue,但项目的README格式实在太乱了,估计是你使用了某款markdown编辑器的语法渲染与github与比较大的出入,所以最好还是根据github上的效果做一些调整,这样对初次接触、想了解你的repo的人会有很大的帮助,说不定可以新增一大波star :P

另外,建议把中英文的文档分开,别说分成两个单独的文件,至少是同一个文件的独立两部分,现在这种“中英文对照”的可读性挺差的,懂中文的人不太会去读你上面的英文,不懂中文的人也看不懂你下面是什么意思,何必呢是吧。

Repo本身还是挺不错的,👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant