Why? Firstly, it will be helpful when launching the project in the future. Let's write down the languages we used, the libraries and its versions. Why did you want to create it? To learn a particular technology? Was it a hackathon project? Was it for a non-profit organization? Is it an application created to memorize the material from workshops or and online course? It's worth mentioning here, without a doubt.
If it's a training project, mention your incentive. Two or three sentences are enough in case of a small project. We should describe in an interesting manner what's the project aim, and what problems does a given application solve. It shouldn't be too long as we don't want to read an essay on a project. In our README.md file, the headings should be written down with a multiple of #: # header H1 To keep our README coherent, we write them similarly in every other document. Moreover, the text should include the titles of sections, and - if necessary - the internal titles. If a project's name doesn't disclose its content, still it's worth to suggest what it is. There is - but you're not aware of that already.Ī title should explain clearly what we have here, and it's usually a project's name - a H1 heading prefaced with #. That's a lot! There's not so much to say about my project! Make sure the file always includes the following elements:Ĭonsider also using additional elements such as: You'll find out more on markdown usage on GitHub, and on dillinger.io you'll find an editor with a preview.
#Android studio github templates code#
md files in any text or code editor (Notepad, Sublime, Atom, CS, etc.). Similarily, we will have # before a heading in our document. In HTML language, the most important heading goes with h1 tag. Maybe at first it isn't be obvious but markup has been created to make text creation easier.
It's a markup language for text formatting. md extension comes from a word: markdown. In every other case, describe your projects in English. The projects realized at the university might be treated as an exeption as they often demand a documentation in Polish. Add a project description in English even if your project is in Polish language. Even a non-technical recruiter will be able to recognize the technologies we touched, and check if it goes in line with a candidate's profile he's/she's looking for.Ĭertainly, in English.
If we are just learning and we drop our training projects there, let's pay attention to their good description. A preparation of several demonstration projects we want to show off during the interview works the best. When we're at a career stage without a considerable commercial experience or nice-looking non-profit projects, a presentation of our achievements in a form of repositories is one of the best way to get visible to the recruiters. The projects on GitHub are most often our portfolio. A good README enables you to relaunch a project - without wasting your time on recalling: What was it all about?įor a budding programmer, GitHub is a calling card. OK, now let's check why we should care for our README files since the first project!Įven if the code is just for you, possibly you will come back to it after a while. I am just learning so why should I be bothered about adding a README file? That code is just for me, after all, not for the whole community. A README file is also essential to retreive a project - on GitHub but also in browsers (e.g. A good README is for others to understand what our code includes, and why it's noteworthy. Rest assured - you will get to know the feeling of disappointment when finding a potential solution to all of your problems in a library or a project which description is poor, useless or isn't available whatsoever. But would we use them if they lacked a user-friendly description, that is, a good README? We use the libraries made available by other developers as an open source code or we make our contribution to a project, reporting/fixing bugs, and adding new functionalities. Certainly, we use these projects because they just come in handy, and offer a high quality solution. If we work professionally or learn coding, many times we come across the public repositories. Example of README for a Bootstrap gem (Ruby On Rails)Īdded README file on GitHub appears under the list of files in a repository.
0 kommentar(er)
