Skip to content

Commit 5a12590

Browse files
authored
Merge pull request #38 from rommapp/replace-release-master
Replace references to release branch with master
2 parents aba5806 + f67c492 commit 5a12590

File tree

7 files changed

+15
-16
lines changed

7 files changed

+15
-16
lines changed

docs/Getting-Started/Configuration-File.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,9 @@ filesystem: { roms_folder: "my_roms" }
9090

9191
<!-- prettier-ignore -->
9292
!!! tip
93-
You can find examples of full binded <a href="https://github.com/rommapp/romm/blob/release/examples/config.batocera-retrobat.yml" target="_blank" rel="noopener noreferrer">batocera</a> or <a href="https://github.com/rommapp/romm/blob/release/examples/config.es-de.example.yml" target="_blank" rel="noopener noreferrer">es-de</a> config files.
93+
You can find examples of full binded <a href="https://github.com/rommapp/romm/blob/master/examples/config.batocera-retrobat.yml" target="_blank" rel="noopener noreferrer">batocera</a> or <a href="https://github.com/rommapp/romm/blob/master/examples/config.es-de.example.yml" target="_blank" rel="noopener noreferrer">es-de</a> config files.
9494

9595
<!-- prettier-ignore -->
9696
!!! warning
9797
Only uncomment or add the lines you need. Any omitted or empty sections will use RomM's defaults.
98-
For a full example, see the <a href="https://github.com/rommapp/romm/blob/release/examples/config.example.yml" target="_blank" rel="noopener noreferrer">config.example.yml</a> file.
98+
For a full example, see the <a href="https://github.com/rommapp/romm/blob/master/examples/config.example.yml" target="_blank" rel="noopener noreferrer">config.example.yml</a> file.

docs/Getting-Started/Folder-Structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ For multifile games (games stored as folders with multiple files or folders insi
155155

156156
## Configuration file
157157

158-
RomM's behavior can be customized using a `config.yml` file or through the `Library Management` page in the `Settings` menu. You can grab the example <a href="https://github.com/rommapp/romm/blob/release/examples/config.example.yml" target="_blank" rel="noopener noreferrer">config.example.yml</a> file and adapt it to your library.
158+
RomM's behavior can be customized using a `config.yml` file or through the `Library Management` page in the `Settings` menu. You can grab the example <a href="https://github.com/rommapp/romm/blob/master/examples/config.example.yml" target="_blank" rel="noopener noreferrer">config.example.yml</a> file and adapt it to your library.
159159

160160
What is shown in the `Library Management` page is the content of the `config.yml`. For more details read the [configuration file](Configuration-File.md) section.
161161

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

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ This guide will assume that you already have the following done, if not - stop h
2424

2525
Now that we have everything gathered, we can begin getting your instance set up!
2626

27-
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
27+
1. Download a copy of the latest <a href="https://github.com/rommapp/romm/blob/master/examples/docker-compose.example.yml" target="_blank" rel="noopener noreferrer">docker-compose.example.yml</a> file from GitHub
2828
2. Edit the file and modify the following values to configure the database
2929
- `MARIADB_ROOT_PASSWORD`: Sets the root password of the database. Use a unique and secure password (_use a password generator for simplicity_)
3030
- `MARIADB_DATABASE`: Sets the database name for RomM. This can be modified - but it's not necessary
@@ -54,8 +54,7 @@ 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
58-
> At this step store the `config.yml` file in this folder
57+
- `/path/to/config`: Path to the directory where you will store the config.yml (store the `config.yml` file in this folder)
5958
7. Save the file as _docker-compose.yml_ instead of _docker-compose.example.yml_. It should look something like this:
6059

6160
<!-- prettier-ignore -->
@@ -83,10 +82,10 @@ Now that we have everything gathered, we can begin getting your instance set up!
8382
}
8483
```
8584

86-
1. Run `docker ps -f name=romm` to verify that the containers are running
87-
2. Open a web browser and navigate to `http://localhost:80`, where you should be greeted with the RomM setup page
88-
3. Go through the setup wizard, setting your admin username and password
89-
4. Log in with the credentials you set in the last step
85+
10. Run `docker ps -f name=romm` to verify that the containers are running
86+
11. Open a web browser and navigate to `http://localhost:80`, where you should be greeted with the RomM setup page
87+
12. Go through the setup wizard, setting your admin username and password
88+
13. Log in with the credentials you set in the last step
9089

9190
## Configure
9291

docs/Platforms-and-Players/Custom-Platforms.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33

44
While RomM supports every platform listed in the [Supported Platforms page](../Platforms-and-Players/Supported-Platforms.md), the list is not exhaustive, and you may have ROMs in your library for other platforms. To load those files into RomM, place them in a folder for each platform, and give it a name that's **all lowercase**, with **`-` to separate words**, and with **no white spaces**. For example, `pocket-challenge-v2` would map to `Pocket Challenge V2`, and display the default platform icon in the app.
55

6-
Furthermore, only a portion of the supported platforms have custom icons built-in. If your library has platforms that aren't listed in [the platforms icons list](https://github.com/rommapp/romm/tree/release/frontend/assets/platforms), RomM will display a default fallback icon.
6+
Furthermore, only a portion of the supported platforms have custom icons built-in. If your library has platforms that aren't listed in [the platforms icons list](https://github.com/rommapp/romm/tree/master/frontend/assets/platforms), RomM will display a default fallback icon.
77

8-
If you'd like to load your own custom icons for missing platforms, you can mount `/var/www/html/assets/platforms` to some local folder and place all of your custom **`.ico`** platform icons in there. You'll also want to download the ones [provided in this project](https://github.com/rommapp/romm/tree/release/frontend/assets/platforms) and place them in the same folder. If you'd like to use your own icons for platforms already supported by RomM, just replace the file with another using the exact same name.
8+
If you'd like to load your own custom icons for missing platforms, you can mount `/var/www/html/assets/platforms` to some local folder and place all of your custom **`.ico`** platform icons in there. You'll also want to download the ones [provided in this project](https://github.com/rommapp/romm/tree/master/frontend/assets/platforms) and place them in the same folder. If you'd like to use your own icons for platforms already supported by RomM, just replace the file with another using the exact same name.
99

1010
**The name of the `.ico` file should match the slug of the platform on IGDB.** For example, the URL for the AmstradCPC is <https://www.igdb.com/platforms/acpc>, so the filename should be `acpc.ico`.
1111

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
This guide assumes you're familiar with Docker and have basic knowledge of TrueNAS. You'll need:
66

77
- A running TrueNAS installation
8-
- Your games setup in the [required folder structure](https://github.com/rommapp/romm/blob/release/README.md)
8+
- Your games setup in the [required folder structure](https://github.com/rommapp/romm/blob/master/README.md)
99

1010
## Setup Process
1111

docs/System-Setup/Unraid-Compose-Setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Click **Add New Stack**
2424

2525
![Edit Stack](../resources/unraid/edit-stack.png)
2626

27-
- Add in the example Docker Compose from our [example docker-compose.yml](https://github.com/rommapp/romm/blob/release/examples/docker-compose.example.yml)
27+
- Add in the example Docker Compose from our [example docker-compose.yml](https://github.com/rommapp/romm/blob/master/examples/docker-compose.example.yml)
2828

2929
- Add your environment variables, for example: API keys, MariaDB info, and metadata providers
3030

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ MariaDB is required to run RomM, so install it from the plugin registry. Only th
1616

1717
![community apps search results for MariaDB](https://github.com/user-attachments/assets/76f4b6ef-5b63-454f-9357-d2920b9afd0e)
1818

19-
Now fill in all the environment variables; descriptions of the options and sensible defaults are listed in the [example docker-compose.yml](https://github.com/rommapp/romm/blob/release/examples/docker-compose.example.yml) file.
19+
Now fill in all the environment variables; descriptions of the options and sensible defaults are listed in the [example docker-compose.yml](https://github.com/rommapp/romm/blob/master/examples/docker-compose.example.yml) file.
2020

2121
<!-- prettier-ignore -->
2222
!!! warning
@@ -32,7 +32,7 @@ From the Unraid dashboard, click `APPS` in the navigation bar. In the search bar
3232

3333
## Configuration
3434

35-
Configure the required environment variables, ports and paths as per the [example docker-compose.yml](https://github.com/rommapp/romm/blob/release/examples/docker-compose.example.yml) file.
35+
Configure the required environment variables, ports and paths as per the [example docker-compose.yml](https://github.com/rommapp/romm/blob/master/examples/docker-compose.example.yml) file.
3636

3737
<!-- prettier-ignore -->
3838
!!! warning

0 commit comments

Comments
 (0)