diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 1f74e20eb..e3f37c412 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,6 +1,6 @@ #### Checklist -- [ ] I have read the [coding conventions](https://github.com/LostArtefacts/TR1X/blob/master/CONTRIBUTING.md#coding-conventions) +- [ ] I have read the [coding conventions](https://github.com/LostArtefacts/TRX/blob/master/CONTRIBUTING.md#coding-conventions) - [ ] I have added a changelog entry about what my pull request accomplishes, or it is an internal change - [ ] I have added a readme entry about my new feature or OG bug fix, or it is a different change diff --git a/README.md b/README.md index 82f7d4c7c..513b81016 100644 --- a/README.md +++ b/README.md @@ -112,8 +112,8 @@ Please refer to the [detailed documentation](docs/tr2/). 4. **Can I play this on Mac, Linux, Android...?** - Currently supported platforms include Windows, Linux and macOS for TR1X, - and Windows for TR2X. + Currently supported platforms include Windows, Linux and macOS for both + TR1X and TR2X. 5. **What's the relation to TR2Main?** diff --git a/docs/tr1/README.md b/docs/tr1/README.md index a3aa24d7d..8f7afc03b 100644 --- a/docs/tr1/README.md +++ b/docs/tr1/README.md @@ -199,7 +199,7 @@ as Notepad. ### Installing -1. Head over to GitHub releases: https://github.com/LostArtefacts/TR1X/releases +1. Head over to GitHub releases: https://github.com/LostArtefacts/TRX/releases 2. Download the `TR1X-Installer.dmg` installer image. Mount the image and drag TR1X to the Applications folder. 3. Run TR1X from the Applications folder. This will show you an error dialog about missing game data files. This is expected at this point, as you have not copied them in yet. However, it's important to run the app first to allow macOS to verify the app bundle's signature. 4. Find TR1X in your Applications folder. Right-click it and click "Show Package Contents". diff --git a/docs/tr2/README.md b/docs/tr2/README.md index e88da1f44..c92ddf54b 100644 --- a/docs/tr2/README.md +++ b/docs/tr2/README.md @@ -18,6 +18,16 @@ game with new enhancements and features. 4. (First time installation) Put your original game files into the target directory. 5. To play the game, run `TR2X.exe`. +## macOS + +### Installing + +1. Head over to GitHub releases: https://github.com/LostArtefacts/TRX/releases +2. Download the `TR2X-Installer.dmg` installer image. Mount the image and drag TR2X to the Applications folder. +3. Run TR2X from the Applications folder. This will show you an error dialog about missing game data files. This is expected at this point, as you have not copied them in yet. However, it's important to run the app first to allow macOS to verify the app bundle's signature. +4. Find TR2X in your Applications folder. Right-click it and click "Show Package Contents". +5. Copy your Tomb Raider 2 game data files into `Contents/Resources`. + ## Improvements over original game #### Gameplay