From 5f4bbbb8dde3e9f4d0d67cd1eebfaeb8ff8842fc Mon Sep 17 00:00:00 2001 From: James Ives Date: Sun, 14 Jul 2024 21:54:38 -0400 Subject: [PATCH] docs: improve REAMDE --- config/README.md | 3 +++ container/config/README.md | 3 +++ container/mods/README.md | 2 +- 3 files changed, 7 insertions(+), 1 deletion(-) diff --git a/config/README.md b/config/README.md index 2be9412..4dd4df8 100644 --- a/config/README.md +++ b/config/README.md @@ -2,6 +2,9 @@ If you wish to add server configurations, such as add-ons, plugins, map rotations, etc, you can add them to the `config` directory. The `config` directory is volume mapped within the directory for the game you're starting the container for. For example, if you're starting a container for `cstrike`, you can add things like `mapcycle.txt` or `motd.txt` here and it would appear within the corresponding `cstrike` directory on the server. +> [!NOTE] +> The startup examples posted in the project README already have this directory volume mapped accordingly. If you've strayed from the suggested setup, [please refer back to it to get started](../../README.md). + ``` ├── hlds │ ├── cstrike diff --git a/container/config/README.md b/container/config/README.md index 2be9412..4dd4df8 100644 --- a/container/config/README.md +++ b/container/config/README.md @@ -2,6 +2,9 @@ If you wish to add server configurations, such as add-ons, plugins, map rotations, etc, you can add them to the `config` directory. The `config` directory is volume mapped within the directory for the game you're starting the container for. For example, if you're starting a container for `cstrike`, you can add things like `mapcycle.txt` or `motd.txt` here and it would appear within the corresponding `cstrike` directory on the server. +> [!NOTE] +> The startup examples posted in the project README already have this directory volume mapped accordingly. If you've strayed from the suggested setup, [please refer back to it to get started](../../README.md). + ``` ├── hlds │ ├── cstrike diff --git a/container/mods/README.md b/container/mods/README.md index 2e85d01..8faeba4 100644 --- a/container/mods/README.md +++ b/container/mods/README.md @@ -19,7 +19,7 @@ If you want to run a custom mod, you can do so with the `mods` directory. The `m ``` > [!NOTE] -> The startup examples posted in the project README already have this directory volume mapped accordingly. If you've strayed from the suggested setup, [please refer back to it to get started](../README.md). +> The startup examples posted in the project README already have this directory volume mapped accordingly. If you've strayed from the suggested setup, [please refer back to it to get started](../../README.md). 1. Create a folder called `mods` that lives alongside where you would normally start the server process. If you've cloned this project locally, you'd place them alongside this README file. 2. Add your mod files as a sub-directory of `mods`. For example if the mod name is `decay`, you'd place it in `mods/decay`.