Update the readme to have standard readme information

Also delete the less-useful directory readmes.
This commit is contained in:
Matthew Lopez 2024-05-27 14:29:23 -04:00
parent 777fa2533a
commit 475a073126
No known key found for this signature in database
GPG Key ID: 302A6EE3D63B7E0E
6 changed files with 31 additions and 30 deletions

View File

@ -13,9 +13,25 @@ self-hosting setup).
| Cemu emulator | ✅ Working |
| 3DS | ✅ Working |
| Citra emulator | ⏱️ Coming soon |
| Wii, Switch | ⛔ Unsupported\* |
| Wii/DS/Switch | ⛔ Unsupported\* |
_\*The Pretendo Network servers only support the Wii U and 3DS consoles._
_\*The Pretendo Network servers only support the Wii U and 3DS consoles. Support for other consoles is not planned._
## Features
- Easily set up and run a Pretendo Network server on your own hardware!
- Everything runs in Docker containers and avoids making changes to your host system.
- Regular updates to support the latest development versions of the servers.
- Source code of the Pretendo servers is
[automatically updated daily by Dependabot](https://github.com/MatthewL246/pretendo-docker/pulls?q=is:pr+author:app/dependabot).
- Supports Wii U and 3DS consoles and emulators with detailed documentation for each.
- Includes server and database administration tools, with easy access through web interfaces.
- Useful scripts for managing the servers.
## Getting started
**Please visit [the documentation website](https://matthewl246.github.io/pretendo-docker) for detailed setup and usage
instructions.**
## Future plans
@ -24,8 +40,15 @@ information on my plans for this project.
## Learn more
- Each of the subdirectories in this repository contain a README file that explains their contents.
- Check the [compose.yml](./compose.yml) file for more information on how the server containers are run.
- Read the source code in the
[Pretendo Network GitHub repositories](https://github.com/orgs/PretendoNetwork/repositories).
- Join the [Pretendo Network Discord server](https://invite.gg/pretendo) and ask questions.
- Read the [containers documentation](https://matthewl246.github.io/pretendo-docker/containers-list) to learn about the
different components of this project.
- Read Pretendo's [Nintendo Wiki](https://nintendo-wiki.pretendo.network/docs/) for technical information about
Nintendo's protocols and their [Developer Documentation](https://developer.pretendo.network/home) for more information
about their libraries and implementations of those protocols.
- See the [Pretendo Network GitHub organization](https://github.com/PretendoNetwork) for all of the open-source servers'
source code.
- Visit the [Pretendo Network forum](https://forum.pretendo.network) (and specifically check out the
[Technical Discussion category](https://forum.pretendo.network/c/technical-discussion/5)) to ask questions about the
servers.
- Join the [Pretendo Network Discord server](https://invite.gg/pretendo) (but please note: this is primarily a general
community server, not a place for technical development discussion).

View File

@ -1,4 +0,0 @@
# Configuration files
These files contain configuration for the containers. They are mounted in the containers using bind mounts. Check
`compose.yml` to see which files are mounted where.

View File

@ -1,7 +1,4 @@
# Console files
This directly includes files that need to be copied to a console to help with the connection setup process, as well as
necessary dumps.
# Console files credits
The program `ResetFriendsTestAccount.3dsx` was created by [Trace](https://github.com/TraceEntertains) (`traceentertains`
on Discord) and was originally shared in the Pretendo Network Discord server as `manual_override.3dsx`. **All credit for

View File

@ -1,5 +0,0 @@
# Environment variables
These files contain environment variables that are used by the containers. Each file is named after the container that
uses it and is specified in `compose.yml`. Keys that end in `.local.env` are ignored by Git, so they are used to store
secrets and are generated by `scripts/setup-environment.sh`.

View File

@ -1,5 +0,0 @@
# Patches
Unfortunately, most of the Pretendo servers do not run without small modifications. This directory contains patches to
make them work. I intend to contribute some of them upstream after further testing, but others are more specific to this
setup.

View File

@ -1,5 +0,0 @@
# Repos
These folders are [Git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) that contain the various
Pretendo Network server repositories. Most are set up to track their repositories' `dev` branches. The configuration is
specified in `.gitmodules`.