Posts
13) - Basic Format & Structure of a Readme.
Welcome back, this is the first side lesson, it is about the readmes. Apparently, and not without reason, readmes have standards. Makes sense but I did not know about it. Easy lesson, probably about half an hour or so, clear and builds up real fast. First about the readmes, then about layout and after that how to represent it. Then moved to knowledge-wikis, how to build and construct them properly (markdown) and some more extra info related to the next review. All in all it is not exactly a lesson, more like some guidelines, guidelines on the bare minimums of readmes. I consider it more like standards of the internet, or as Joel might have said it "The absolute bare minimums every developer should now about Readmes". Good conduct, read it, learn what a readme me is, the reason for existence, etc. You know, I have some years on me, some years of home computer repairs going around folks places and repairing or making changes to personal computers. The reason I am telling you this, is cause due to this when a readme is on my way it gets tossed instantly. That did change after that. It is now my firm believe, that readmes are a very important part of any project. Please add it to the requirements. Licenses as well, more on that on another article. Next is Markdown.
Welcome back, this is the first side lesson, it is about the readmes. Apparently, and not without reason, readmes have standards. Makes sense but I did not know about it. Easy lesson, probably about half an hour or so, clear and builds up real fast. First about the readmes, then about layout and after that how to represent it. Then moved to knowledge-wikis, how to build and construct them properly (markdown) and some more extra info related to the next review. All in all it is not exactly a lesson, more like some guidelines, guidelines on the bare minimums of readmes. I consider it more like standards of the internet, or as Joel might have said it "The absolute bare minimums every developer should now about Readmes". Good conduct, read it, learn what a readme me is, the reason for existence, etc. You know, I have some years on me, some years of home computer repairs going around folks places and repairing or making changes to personal computers. The reason I am telling you this, is cause due to this when a readme is on my way it gets tossed instantly. That did change after that. It is now my firm believe, that readmes are a very important part of any project. Please add it to the requirements. Licenses as well, more on that on another article. Next is Markdown.
Comments
Post a Comment