Skip to content

Commit b97a62f

Browse files
authored
Add top level folders to README.md (#170)
Added some description to what is found in each of the top level folders. Also fixed a bad Markdown link I did in the previous PR.
1 parent 64f61d9 commit b97a62f

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,17 @@ Projects and products utilised include:
2424
The **Droid Shooter** game, is composed of a game client and dedicated server, and multiple backend services hosted
2525
around the globe.
2626

27+
### Top Level Folders
28+
29+
| Folder | Description |
30+
|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
31+
| [infrastructure](./infrastructure) | This contains all the Terraform scripts and resources to create the infrastructure that the project relies on. It is worth noting that the Terraform scripts will generate configuration files that are used by Cloud Deploy and Kubernetes in both the `platform` and `services` directories |
32+
| [platform](./platform) | The `platform` directory contains the Cloud Build and Cloud Deploy scripts to set up the application platforms, such as Open Match and Agones, on the infrastructure that the `infrastructure` folder provisions. |
33+
| [services](./services) | Contains the code for all the backend services that Droid Shooter requires, and Cloud Build and Cloud Deploy scripts to build and deploy these services to their appropriate hosting and storage infrastructure. |
34+
| [game](./game) | The code for the game launcher, client and server, as well as Cloud Build, Cloud Deploy and Agones configurations for building and hosting the dedicated game servers |
35+
36+
### System Components
37+
2738
![Architecture diagram](images/architecture.png)
2839

2940
| Component | Technologies | Description |
@@ -39,7 +50,7 @@ around the globe.
3950
[Fyne]: https://developer.fyne.io/index.html
4051
[Agones Fleet]: https://agones.dev/site/docs/getting-started/create-fleet/
4152
[Agones Latency Ping endpoints]: https://agones.dev/site/docs/guides/ping-service/
42-
[Agones Allocator Endpoints]: https://agones.dev/site/docs/advanced/allocator-service/
53+
[Agones Allocator Service]: https://agones.dev/site/docs/advanced/allocator-service/
4354

4455
## Run in Your Google Cloud Project
4556

0 commit comments

Comments
 (0)