Skip to content

Commit

Permalink
Update README.md grammar
Browse files Browse the repository at this point in the history
  • Loading branch information
thejcpalma committed Nov 26, 2023
1 parent eed9e55 commit 628c238
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ This is intended to make hosting a ~lan~ server easier and faster, removing the
This Repository is a work in progress state, so if you think there's an improvement to be made please contribute in the Issues Tab

- Currently this repository is only tested in Linux, but it should work in any system able to run Docker.
- Currently this repository is only tested in Linux and Windows, but it should work in any system able to run Docker.

- It's also only tested in a LAN environment, but it should work in a WAN environment as well.
- It's also only tested in a LAN environment (which can be accessed externally, for example, with a reverse proxy), but it should work in a WAN environment as well.

- And it's only tested with the Zombie mode, but it should work with the Multiplayer mode as well.
- And it's only tested with the Zombie mode, but it should work with the Multiplayer mode as well (hopefully).

> Don't quote me on the statements above :sweat_smile:
Expand Down Expand Up @@ -46,7 +46,7 @@ For easier setup, we use the name `aio-plutonium-t6` for the volume:
docker volume remove aio-plutonium-t6 || true && \
docker volume create aio-plutonium-t6
```
> **Note:** We first remove the volume if it exists, to avoid any errors. Be carefil when using this command, as it will remove any data stored in the volume.
> **Note:** We first remove the volume if it exists, to avoid any errors. Be careful when using this command, as it will remove any data stored in the volume.

### 2. Launching the server
Expand Down Expand Up @@ -209,6 +209,7 @@ Here the default value is `1624`, but you can change it to whatever you want, as

So if you mapped the port `1625` in the `-p <admin_panel_host_port>:1625/tcp` parameter, you must change the `ADMIN_PORT` environment variable to `1625` as well.


## Credits

Projects used in this repository:
Expand All @@ -223,3 +224,12 @@ Projects used in this repository:
- [rexlManu](https://github.com/rexlManu)/[t6server-docker-setup](https://github.com/rexlManu/t6server-docker-setup)

*Without their repositories, this repository would not exist. So thank you very much for your work.* :heart:


## TODO List

- [ ] Add env to shell script for the server password
- [ ] Fix README.md/Documentation with more links and useful information
- [ ] Reduce clutter on dockerfile (apt update, ...)
- [ ] Isolate installation scripts into separate files (like the updater and the wine installation)

0 comments on commit 628c238

Please sign in to comment.