Skip to content

Commit d573dec

Browse files
committed
tweaks
1 parent ceffd5f commit d573dec

File tree

3 files changed

+23
-23
lines changed

3 files changed

+23
-23
lines changed

docs/Getting-Started/Quick-Start-Guide.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This guide will assume that you already have the following done, if not - stop h
1414
- [Docker installed](https://docs.docker.com/get-docker/) and running on your system
1515
- Your ROMs organized in the correct [folder structure](./Folder-Structure.md)
1616
- The recommended [metadata providers](./Metadata-Providers.md) set up
17-
- A copy of the config.yml from [RomM Github](https://github.com/rommapp/romm/blob/master/examples/config.example.yml) - This is now mandatory since 4.1
17+
- A copy of the [config.yml](https://github.com/rommapp/romm/blob/master/examples/config.example.yml) in the config folder
1818

1919
<!-- prettier-ignore -->
2020
!!! warning
@@ -54,7 +54,8 @@ Now that we have everything gathered, we can begin getting your instance set up!
5454
6. Modify the following values in the **volumes** to configure the application
5555
- `/path/to/library`: Path to the directory where your rom files will be stored (usually the parent folder of the `roms` folder)
5656
- `/path/to/assets`: Path to the directory where you will store your saves, etc
57-
- `/path/to/config`: Path to the directory where you will store the config.yml - At this step please store the `config.yml` file in this folder now.
57+
- `/path/to/config`: Path to the directory where you will store the config.yml
58+
> At this step store the `config.yml` file in this folder
5859
7. Save the file as _docker-compose.yml_ instead of _docker-compose.example.yml_. It should look something like this:
5960

6061
<!-- prettier-ignore -->
@@ -66,21 +67,21 @@ Now that we have everything gathered, we can begin getting your instance set up!
6667
8. Open the terminal and navigate to the directory containing the docker-compose file
6768
9. Run `docker compose up -d` to kick off the docker pull. You will see it pull the container and set up the volumes and network:
6869

69-
```asciinema-player
70-
{
71-
"file": "../latest/resources/asciinema/quick-start-docker-compose.cast",
72-
"title": "RomM docker compose install",
73-
"preload": true,
74-
"loop": true,
75-
"auto_play": true,
76-
"cols": 140,
77-
"rows": 30,
78-
"fit": "width",
79-
"terminal_font_size": "small",
80-
"terminal_line_height": "1.2",
81-
"terminal_font_family": "Roboto Mono, Monaco, Consolas, monospace"
82-
}
83-
```
70+
```asciinema-player
71+
{
72+
"file": "../latest/resources/asciinema/quick-start-docker-compose.cast",
73+
"title": "RomM docker compose install",
74+
"preload": true,
75+
"loop": true,
76+
"auto_play": true,
77+
"cols": 140,
78+
"rows": 30,
79+
"fit": "width",
80+
"terminal_font_size": "small",
81+
"terminal_line_height": "1.2",
82+
"terminal_font_family": "Roboto Mono, Monaco, Consolas, monospace"
83+
}
84+
```
8485

8586
1. Run `docker ps -f name=romm` to verify that the containers are running
8687
2. Open a web browser and navigate to `http://localhost:80`, where you should be greeted with the RomM setup page

docs/Platforms-and-Players/EmulatorJS-Player.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
PSP emulation with the PPSSPP core and MS-DOS with the dosbox-pure core requires one of the three options:
1212

1313
- the unofficial [desktop app](https://github.com/smurflabs/RommBrowser/releases) published by [smurflabs](https://github.com/smurflabs). Once logged into the app, you can enable the required settings under `Developer Settings`. (Preferred)
14-
- [special setup with a reverse proxy](https://emulatorjs.org/docs/options#ejs_threads) - If you use this you will be **MISSING** features within RomM and it is recommended to use the WebApp
14+
- [special setup with a reverse proxy](https://emulatorjs.org/docs/options#ejs_threads) (which will break features within the app and is not recommended)
1515
- launching Chrome browser with the `--disable-web-security` and `--enable-features=SharedArrayBuffer` flags, which **WE STRONGLY DISCOURAGE** as it disables important security features.
1616

1717
<!-- prettier-ignore -->

docs/System-Setup/Synology-Setup-Guide.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,12 @@
22

33
## External Written Guides
44

5-
While you can follow the below guide, there is written guides done by [Marius Bogdan Lixandru](https://mariushosting.com/) which focus on the synoloy infrastructure and using portainer. This supports both MariaDB and PostGresSQL.
5+
While you can follow the below guide, [Marius Bogdan Lixandru](https://mariushosting.com/) has written excellent guides which focus on Synology infrastructure and with support for both MariaDB and PostGresSQL:
66

7-
[How to Install RomM on Your Synology NAS (MariaDB)](https://mariushosting.com/how-to-install-romm-on-your-synology-nas/)
7+
* [How to Install RomM on Your Synology NAS (MariaDB)](https://mariushosting.com/how-to-install-romm-on-your-synology-nas/)
8+
* [How to Install RomM With PostgreSQL on Your Synology NAS](https://mariushosting.com/how-to-install-romm-with-postgresql-on-your-synology-nas/)
89

9-
[How to Install RomM With PostgreSQL on Your Synology NAS](https://mariushosting.com/how-to-install-romm-with-postgresql-on-your-synology-nas/)
10-
11-
We would suggest to follow the above guides depending on your setup, but we will leave the other guide below as it was written by a community member.
10+
We suggest following the above guides if they fit your setup, and the guide below is available for all other use cases.
1211

1312
## Prerequisites
1413

0 commit comments

Comments
 (0)