This is my How-To Guide, a beginner’s introduction to writing a README file created for a project in UWP 101V at UC Davis. I formatted the guide to visually resemble a VS Code coding window. I created a dark background, typewriter sort of font, and a color-coded Markdown syntax as a rhetorical choice to make the guide feel more natural to the environment where READMEs are typically written. I organized the sections into rhetorical moves, ranging from obligatory ones like the project title and references to context-specific ones like generative AI documentation. I also embedded examples from professional READMEs from React and VS Code, as well as the README I wrote for a course.
Read it here: How to Write a README.md