Write a great README

Are you going?

17 spots left

Share:
Location image of event venue

Details

Lorna Jane will give a talk on READMEs.

Having a good README file in every GitHub project is a key ingredient of good developer experience, but what makes a good README? This talk looks at the various types of projects you might want to create a README for, and offers examples of good README practice in each case. Making sure the purpose and status of the project is key, and directing users to your (beautiful and actively maintained) main documentation is definitely part of the deal. But we can do more to engage and inform developers that reach our projects this way, and this session will show you how. Recommended for everyone who wants to make the projects we create a welcoming place for users, however they find us.

There will then be time to work on a README for one of your projects. We will also bring some READMEs to work on if you don't have your own. The sample projects will be on GitHub.

The venue:

The Victoria Hotel is a pub in the centre of Leeds. We have reserved a room, so there will be quiet, and space to work.

Requirements:

Bring a laptop. If you want to work on one of our sample projects, you will need a GitHub account.