This repository forms the main project catalogue for Railway Operation Simulator community created content, projects are added as Git submodules from their source repository. These repositories are typically created using the Template project.
The project kanban board can be used to keep track of what projects are ongoing, you are welcome to add your own projects here.
When adding a project to the board please ensure you:
- Firstly add a card to the relevant column, then make sure to convert the card to an issue under the
ProjectStatusrepository. - Project name in the usual form of
<country-abbreviation> <name>(e.g.GB Crewe). - In the description provide a link to the GitHub repository for the project itself (e.g. FR Paris Metro)
- Tag the issue with the relevant labels (see below)
The project status columns are:
Proposed: projects which are under proposal with no work yet carried out.Awaiting Requirement: "stale" projects which are missing a feature.Map Under Edit: you/a user is actively editting the map, make sure to assign yourself to the issue as well!Timetable Under Edit: you/a user is creating a timetable for the simulation, make sure to assign yourself to the issue as well!Under Review: project is in beta/open to testing (this can be before release, or after as long as a new release is planned)Released: project is complete and available for download.
Labels provide a way of quickly determining the state of a project from the issue side. Make sure you assign the label relevant to the column the project is in, and if the project is "Awaiting Requirement" you specify what the requirement is with the requires x labels.