Skip to content

Commit

Permalink
Merge branch 'main' of github.com:Railway-Op-Sim/ROSPkgManager
Browse files Browse the repository at this point in the history
  • Loading branch information
artemis-beta committed Jan 22, 2022
2 parents 84ab5fc + ad0b57c commit 9084b3d
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
<p align="center">
<img
style="display: block;
margin-left: auto;
margin-right: auto;
width: 30%;"
src="https://raw.githubusercontent.com/Railway-Op-Sim/ROSPkgManager/main/img/rospkgmanager.svg"
alt="Our logo">
</img>
</p>

# Railway Operation Simulator Package Manager

[![Build & Test](https://github.com/Railway-Op-Sim/ROSPkgManager/actions/workflows/build_packager.yaml/badge.svg)](https://github.com/Railway-Op-Sim/ROSPkgManager/actions/workflows/build_packager.yaml) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Railway-Op-Sim_ROSPkgManager&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Railway-Op-Sim_ROSPkgManager)

This application aims to simplify the process of adding and removing route simulations to the local installation of [Railway Operation Simulator](https://railwayoperationsimulator.com/) (ROS), a railway signalling simulation by Albert Ball.

Full documentation can be found on the [project website](https://railway-op-sim.github.io/ROSPkgManager/).

## Getting Started
On first launch you will need to specify the location of the `railway.exe` ROS executable on your system, this location is used to determine where add-ons should be installed. Once this is set the location will be cached and so no longer required. Functionality for altering the installation will be added at a later date. Within this manual `${ROS_HOME}` refers to the directory containing `railway.exe`.

Expand Down Expand Up @@ -33,6 +47,9 @@ The buttons next to the file declaration fields allow you to browse for files to
|Factual|If simulation is a factual representation.|
|Year|Year for which this simulation is a representation (can be any value if fictional).|

## Upgrading Railway Operation Simulator
If select a zip file containing a `railway.exe` executable the program will assume it to be a copy of the main ROS program and ask if you wish to
upgrade your local installation with the files contained.

## Advanced
Clicking the "Advanced" checkbox shows additional options for package installation.
Expand Down

0 comments on commit 9084b3d

Please sign in to comment.