When the RLC Analyser is started the user is prompted to browse to search for a new folder or RLC to process. Alternatively, the user can also process the default folder/file displayed. Instructions are provided on the top of the window.
Navigate to the Release tab on GitHub. Download the latest release version - current version is v1.0. This JAR file contains the latest built version of the RLC Analyser.
In order to run the JAR file, Java 8 needs to be installed. To run the JAR double click on the icon. Skip the next step if permissions are not denied.
- On Mac - permissions may need to be changed. Open System Preferences -> Security & Privacy -> General -> Open Anyway.
- Download the latest Eclipse Oxygen - Eclipse for RCP and RAP Developers
- Install Eclipse
- Start Eclipse and create a workspace for the RLC Analyser Project
| Settings Panel | Change |
|---|---|
| Window (Menu) -> Preferences -> Java -> JUnit | Select the "add -ea to VM arguments when creating JUnit launch configuration" checkbox |
Apply the changes and close.
- Uncheck the "Build Automatically" menu item in the "Project" menu.
- Re-enable automatic building once the code has been successfully imported and the Target Platform configured and refreshed.
Either clone the project using Git or download the project into local drives.
- In the main page, click the "Clone or Download" button and select from one of the options given.
- Open the project import dialog: "File" menu > "Import..." menu item
- Expand the "Maven" folder, select "Existing Maven Projects" and click the "Next > " button
- Select the root directory as the directory of the downloaded project location
- Click "Finish"
In the "Project" menu, check the "Build Automatically" menu item.
- From the "Run" menu, click on "Run Configurations...".
- Right click "Java Application" -> click "New".
- Set name to "RLCAnalyserStart" or anything similar.
- Under Project, click "Browse..." -> select the RLC Analyser project -> click "Ok".
- Click "Search..." -> select "com.orchestral.rhapsody.rlcanalyser.RlcAnalyserConsole" -> click "Ok".
- Click "Apply" -> click "Run".
Note: A warning should appear in the Eclipse console on first start due to the initialisation of the logger files, on the next launch these warning should disappear.
- From the "Run" menu, click on "Run Configurations...".
- Right click "JUnit" -> click "New".
- Set name to "RLCAnalyserTest" or anything similar.
- Select "Run all tests in the selected project, package or course folder:".
- Click "Search..." -> Select the RLCAnalyser project.
- Ensure the "Test runner" field is set to "JUnit 4".
- Click "Apply" -> "Run".
- Right click on your project and select Run As > Maven build..
- In the Goals text field, type 'install', apply and run.
If you get a compilation error such as: "No Compiler is provided in this environment. Perhaps you are running a JRE rather than a JDK?" after running the Maven Goal, try this:
- Run Menu > Run Configurations > Maven Build > Select an existing build or create a new one > Under the JRE tab ensure that the default Workspace JRE is checked > Uncheck and check this checkbox.
- Return to the main tab and run again with the install goal.
For each feature or improvement please refer to the Projects that are currently opened under the Projects tab above. If the project is not currently opened:
- Make a new project with a clear title and description. Set the project up so has the basic KANBAN style.
- Add appropriate to-dos.
Use this space to populate the projects with sub tasks.
If you notice a bug or problem with the functionality of the code, create an issue and in the GitHub Issue Tracker tab in the top bar.
To ensure that the code is maintained to a satisfactory standard, all changes made to the program should undergo an approval process before merging to the master branch.
- Fork the orionhealth/rlc-analyser repository.
- Create a new pull request when you want to push changes.
- Await approval
- The pull request must pass the build and the code review process.