These are for our benefit, not the computer. So another good practice is to use good, descriptive names on files, directories, and in code. Later never comes, or we forget the details by the time it does. We’ve all had projects under a deadline or someone asking for a result, and the documentation step is easy to defer until later. READMEs are commentary on what we consider the “real work”, and realistically can be an afterthought. When changing something in a directory, you should add a line at the README.For other directories like code or documentation, the README should communicate what the directories contain.For modified data directories, you should include the exact tools and steps used to modify the data, along with dates.For raw data directories, you should include the location (e.g URL) where the file was retrieved or generated.Often there are many files, and it’s distracting to fill the top-level README with details about smaller pieces of the project. README files in subdirectories are a good idea too. This file serves as the starting point for future you, or anyone who receives this data. Save as README in the project directory.For Mac users this can be BBEdit, NotePad++ for Windows users.ģ-4 sentences about the goal of the project To add a README to our project, open a text editor. So, before we make any modifications to the raw data, we need a practice for how to record the initial state of the data, as well as our modifications. These are the things that would have made it easy to make sense of that data. Think about the beginning of this lesson, when we had nothing but a file with a name. If the project uses data from an external source, where the data is from.Three or four sentences about the goal of the project.Contact information for the person(s) who maintains the project. A README file should include the following information: As the starting point for a project the README file is formatted as plain text (or markdown) to make it easily readable. Describe the purpose of including README files with your project.ĭescribe common locations for README files.ĭescribe the appropriate level of detail to include in a README.Įvery project should describe to users what the purpose of the project is.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |