Skip to content

Commit 0f4c703

Browse files
committed
fix: Update links and improve formatting in Quick Start Guide
1 parent 45fffe6 commit 0f4c703

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

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

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ This quick start guide will help you get a RomM instance up and running. It is s
1111
This guide will assume that you already have the following done, if not - stop here and come back when you do.
1212

1313
- Docker and Docker Compose installed
14-
- A [Twitch](https://dev.twitch.tv) account (optional)
14+
- A <a href="https://dev.twitch.tv" target="_blank" rel="noopener noreferrer">Twitch</a> account (optional)
1515
- 2-factor authentication set up on your Twitch account
1616
- _This is required to get a developer account and an IGDB key_
17-
- A [Screenscraper](https://www.screenscraper.fr/) account (optional)
17+
- A <a href="https://www.screenscraper.fr/" target="_blank" rel="noopener noreferrer">Screenscraper</a> account (optional)
1818
- Your ROMs organized in the correct [folder structure](../Folder-Structure)
1919

2020
<!-- prettier-ignore -->
@@ -30,44 +30,44 @@ Head over to [API key docs](../Generate-API-Keys) to get your IGDB and/or Screen
3030
Now that we have everything gathered, we can begin getting your instance set up!
3131

3232
<!-- trunk-ignore-begin(markdownlint/MD040) -->
33-
1. Download a copy of the latest [docker-compose.example.yml](https://github.com/rommapp/romm/blob/release/examples/docker-compose.example.yml) file from GitHub
34-
2. Edit the file and modify the following values to configure the database
33+
1. Download a copy of the latest <a href="https://github.com/rommapp/romm/blob/release/examples/docker-compose.example.yml" target="_blank" rel="noopener noreferrer">docker-compose.example.yml</a> file from GitHub
34+
3. Edit the file and modify the following values to configure the database
3535
- `MARIADB_ROOT_PASSWORD`: Sets the root password of the database. Use a unique and secure password (_use a password generator for simplicity_)
3636
- `MARIADB_DATABASE`: Sets the database name for RomM. This can be modified - but it's not necessary
3737
- `MARIADB_USER`: User to connect to the database with. This can be modified - but it's not necessary
3838
- `MARIADB_PASSWORD`: Password for the user to connect to the database with. Use a unique and secure password (_use a password generator for simplicity_)
39-
3. Modify the following values in the **environment** to configure the application. _-- Other values can be changed, but should not be done unless you know what you are doing, and are outside the scope of this guide_
39+
4. Modify the following values in the **environment** to configure the application. _-- Other values can be changed, but should not be done unless you know what you are doing, and are outside the scope of this guide_
4040
- `DB_NAME`: Name of the database set in the database section
4141
- `DB_USER`: Name of the user to connect to the database
4242
- `DB_PASSWD`: Password of the user to connect to the database
43-
4. Run the following command in a terminal and save the output to the `ROMM_AUTH_SECRET_KEY` environment variable:
43+
5. Run the following command in a terminal and save the output to the `ROMM_AUTH_SECRET_KEY` environment variable:
4444
```sh
4545
openssl rand -hex 32
4646
```
4747
It should look something like this:
4848
```sh
4949
03a054b6ca27e0107c5eed552ea66becd9f3a2a8a91e7595cd462a593f9ecd09
5050
```
51-
5. Add your metadata sources API keys:
51+
6. Add your metadata sources API keys:
5252
- IGDB: `IGDB_CLIENT_ID` and `IGDB_CLIENT_SECRET`
5353
- SCREENSCRAPER: `SCREENSCRAPER_USER` and `SCREENSCRAPER_PASSWORD`
54-
6. Modify the following values in the **volumes** to configure the application
54+
7. 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
5757
- `/path/to/config`: Path to the directory where you will store the config.yml
58-
7. Save the file as _docker-compose.yml_ instead of _docker-compose.example.yml_. It should look something like this:
58+
8. Save the file as _docker-compose.yml_ instead of _docker-compose.example.yml_. It should look something like this:
5959

6060
<!-- prettier-ignore -->
6161
???+ example "Example Docker Compose"
6262
``` yaml
6363
--8<-- "quick-start.docker-compose.yml"
6464
```
6565

66-
8. Open the terminal and navigate to the directory containing the docker-compose file
67-
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:
66+
9. Open the terminal and navigate to the directory containing the docker-compose file
67+
10. 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:
6868
```asciinema-player
6969
{
70-
"file": "../resources/asciinema/quick-start-docker-compose.cast",
70+
"file": "https://raw.githubusercontent.com/rommapp/docs/refs/heads/main/docs/resources/asciinema/quick-start-docker-compose.cast",
7171
"title": "RomM docker compose install",
7272
"preload": true,
7373
"loop": true,
@@ -105,8 +105,8 @@ This method is certainly viable, but not recommended if you have a lot of ROMs a
105105
106106
1. Log into RomM with your user credentials
107107
2. Click the `Upload` button in the sidebar
108-
3. Select the platform, then click _ADD ROMs_ and select the ROMs you want to upload in the file selector that appears
109-
4. Click _UPLOAD_ to begin uploading the ROMs
108+
3. Select the platform, then click `+ ADD` and select the ROMs you want to upload in the file selector that appears
109+
4. Click `Upload` to begin uploading the ROMs
110110
5. Repeat for all the `roms/platforms` you have
111111
112-
<img src="https://github.com/rommapp/romm/assets/3247106/3e398e7a-d653-472c-9f11-82b2f0b52840" width="780" alt="upload dialog">
112+
<img src="https://raw.githubusercontent.com/rommapp/docs/refs/heads/main/docs/resources/quickstart/upload_roms.png" width="780" alt="upload dialog">

0 commit comments

Comments
 (0)