github的readme怎么写

如题所述

创建ssh:  接下来打开终端(不知道终端在哪儿的,就直接在spotlight里搜terminal):  $cd~/.ssh//检查是否已经存在ssh  如果存在,先将已有的ssh备份,或者将新建的ssh生成到另外的目录下  如果不存在,通过默认的参数直接生成ssh:  [email protected](注册github时的email)  Generatingpublic/privatersakeypair.  Enterfileinwhichtosavethekey(/Users/twer/.ssh/id_rsa):  Createddirectory'/Users/twer/.ssh'.  Enterpassphrase(emptyfornopassphrase):  Entersamepassphraseagain:  Youridentificationhasbeensavedin/Users/twer/.ssh/id_rsa.  Yourpublickeyhasbeensavedin/Users/twer/.ssh/id_rsa.pub.  Thekeyfingerprintis:  18:16:11:c9:01:6c:48:09:7f:27:c6:43:0d:7f:3f:[email protected]  Thekey'srandomartimageis:  +--[RSA2048]----+  |.o.++===|  |.ooo.+..|  |..*=E.|  |o=+o|  |.So|  |.|  ||  ||  ||  +-----------------+  如果要修改ssh生成目录,在粗体位置处输入要生成的路径,选择默认的话,会生成在~/.ssh下  在github中添加ssh(如图示):  登陆github,选择AccountSettings-->SSHKeys添加ssh  Title:[email protected]  Key:打开你生成的id_rsa.pub文件,将其中内容拷贝至此。    打开终端,先测试一下你的帐号跟github连上没有:[email protected]如果出现如下提示,表示你连已经连上了.(因为有了第一步,所以不用自己做过多的连接github的操作了,另外,下一次要连接github的时候记得打开第一步的工具).  HiMiracleHe!You'vesuccessfullyauthenticated,butGitHubdoesnotprovideshellaccess.  接下来就可以上传你的代码了,在github下建自己的Repository。CreateaNewRepository如下:    Repositoryname:通常就写自己自己要建的工程名。  Description:就是你对工程的描述了。  选择Public。  点击“Createrepository”,出现如下图:    按照上面的步骤来就行了(注意记得在终端中输入时把目录切换到你要上传的工程目录下)。简单分析下上面的步骤:  touchREADME.md//新建一个记录提交操作的文档  gitinit//初始化本地仓库  gitaddREADME.md//添加  gitcommit-m"firstcommit"//提交到要地仓库,并写一些注释  [email protected]:youname/Test.git//连接远程仓库并建了一个名叫:origin的别名  gitpush-uoriginmaster//将本地仓库的东西提交到地址是origin的地址,master分支下  需要注意的问题,进行如下操作时:  Key:打开你生成的id_rsa.pub文件,将其中内容拷贝至此  这里的id_rsa.pub文件是在.ssh目录下,可能有小伙伴会发现自己的mac下没看见.ssh目录,难道是我忽悠大家啦?当然不会啦,这么败人品的事我怎么可能会做。没看见.ssh目录,是因为mac把这个目录给隐藏了,如果你不信,你可以进行如下操作把隐藏文件给显示出来。  显示Mac隐藏文件的命令:defaultswritecom.apple.finderAppleShowAllFilesYES  隐藏Mac隐藏文件的命令:defaultswritecom.apple.finderAppleShowAllFilesNO  输完单击Enter键,退出终端,重新启动Finder就可以了  其实虽然你可能看不到.ssh目录,但你还是可以通过终端命令来查看到.ssh目录的,操作如下:    通过catid_rsa.pub查看里面是一大串云里雾里的东西,不需要看懂,复制到“key”里就行了。
温馨提示:答案为网友推荐,仅供参考
第1个回答  2018-08-03
github还为码农提供了一个博客系统,叫做githubpages。尝试了一下,深深爱上之。自己在博客园写blog也好多年了,说心里话,博客园做得还是不错,相比那个叫CSDN的,好了很多,这也是这么多年能坚持下来的原因。但是,突然有一天,我遇上了macpro,我又为之倾倒,我想我以后,再也不会买windows的个人电脑了,除非工作需要。原来在windows下,用windowslivewriter写blog,也挺方便的,但macosx上却没有,找了许久,找到了一个找marsedit的东西,实在是太粗糙了,强忍着用了一段时间,实在难以忍受。。。再后来,我发现博客园支持markdown(从这里可以看出博客园的确是在用心),不由于为之欣喜,sublime/vim+mardown是写mac下写博客的最好的方法,个人觉得。。。  我不想为了写blog,去学习各种让人蛋疼的工具和配置,我认为人的时间应该花在有意义的地方,比如深入读一读linux,mysql这些开源项目的源码,或者泡泡妞也可以,或者陪陪家人。所以,我一直没有自己搭建一个网站。“众里寻它千百度,那人却在灯火阑珊处”,当我遇到github  page的那一刻,发现它正是我苦苦寻找的东西。  从此,我想我只会用mac+github+markdown+  sublime/vim写blog了。。。本回答被网友采纳
第2个回答  2016-07-29
好的readme,如何才算好,一定要有高逼格,好吧,中文不够国际化,一定要有英文版本

首先logo很重要放在最上面,如meolu/walle-web · GitHub,然后起一个最耍帅的名字,如meolu/walden · GitHub:Walden 最适合东半球同学使用的文档框架。

最重要的,一定要有一个官方主页介绍,不求漂亮、高大上,至少做得大方得体,瓦尔登官方主页:Walden 瓦尔登。最好为它申请一个专业的域名,如瓦力官方主页:walle-web.io,.io域名比.com贵太多了:( 不过,好马配好鞍,谁让它是我的理想寄托,值!

介绍当然是少不了,这块可高大上,可幽默,看个人文笔了,目前我还没想好一套超酷的,先等着。

对于技术的readme,一定要各种icon:travis、scrutinizer、packagist这些标配

至于什么安装,快速开始,功能列表这不啰嗦了,然后就是尽量给个截图或者gif,吸引兴趣,让用户看到完成之后的样子。本回答被网友采纳
相似回答