search

labscript-suite-oldfinal1 / installer

The installer for the labscript suite. This repository is used used to build zip files containing an install script and all the labscript suite python packages.
BSD 2-Clause "Simplified" License
0 stars 0 forks source link

Rename this repository to something like 'labscript_suite' and have it contain central docs etc #24

Open philipstarkey opened 6 years ago

philipstarkey commented 6 years ago

Original report (archived issue) by Chris Billington (Bitbucket: cbillington, GitHub: chrisjbillington).

Open source projects commonly have a single repository that acts as a landing page with an informative README and all the rest for the project as a whole. We don't have one of these.

Make the installer repo take on this role, by renaming it to 'labscript_suite' or similar, and have it contain any 'getting started' or otherwise common documentation. Then this repository can be the one linked to when we want to link to 'the development repository'. The README will explain that there are subprojects under different version control repos.

Having a landing page like this is important for giving people encountering the project for the first time a good sense of what a project is about. 'getting started' sphinx docs can be configured to render both to a README file and to readthedocs.io, such that someone being linked here can get a good introduction from the README alone, with a 'click here for more' linking to readthedocs. All these things are also great for search engine visibility.

philipstarkey commented 6 years ago

Original comment by Chris Billington (Bitbucket: cbillington, GitHub: chrisjbillington).