This is the sign-up form for the 8th Byte-sized RSE session which will cover README files. The event will be hosted online via Zoom on Tuesday 6th June 2023, 13:00-14:00 BST/UTC+1. The Zoom link will be emailed to registered participants shortly before the session.
This session will look at the importance of README files in supporting and promoting projects. In modern projects, a README file is much more than a simple text file telling people what the project is and who to contact about it!
README files can include a whole range of information from documentation, installation instructions and licensing details to information on how to contribute to the code and how to cite the software. With modern text markup and formatting through Markdown, README files can also be rendered in a much more accessible and appealing manner than traditional plain text README files.
In this session, we'll show you how to make the most of your README files, especially when hosting your code within software repositories such as GitHub or GitLab.
Session prerequisites:
README files can be created in a text editor of your choice. You should ensure that you have a basic text editor installed on your system, alternatively you can use an IDE that you are familiar with for writing code.
We also strongly recommend that you have an account on GitHub.com in order to be able to participate fully in the interactive part of the session.
- Personal information you supply to us through this form will be used only for the purposes of contacting you to join the event, for monitoring the outcomes from the event, and to get feedback on the event. We will hold the personal data you have provided for a period of one year after the final day of the event, at which point it is deleted. You have the right to request a copy of the information we hold about you and ask us to correct or remove information, please email s.crouch@software.ac.uk or jeremy.cohen@imperial.ac.uk. We are collecting your contact details in accordance with the Software Sustainability Institute's privacy policy. For more information, please see https://software.ac.uk/privacy-events.
