+
+
+
-Documentation for open source GameCI projects. You can find the `.md` files inside the -[docs](./docs) folder. The live version is available on [game.ci](https://game.ci). This website is -built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. +
-### Installation
+
-```bash
-yarn
-```
+## Welcome
-### Local Development
+Welcome to the GameCI documentation repo! Here you will find the documentation assests for GameCI
+and it's related open-source projects. The live documentation site availble at
+game.ci.
-```bash
-yarn start
-```
+You may also view the markdown files directly at the following links:
-This command starts a local development server and opens up a browser window. Most changes are
-reflected live without having to restart the server.
+- [Getting Started with GameCI](docs/02-getting-started)
+- [Github Actions](docs/03-github)
+- [Gitlab Pipelines](docs/05-gitlab)
+- [CircleCi<](docs/11-circleci)
+- [Docker](docs/08-docker)
+- [Github Cloud Runner](docs/03-github-cloud-runner)
+- [Troubleshooting](docs/09-troubleshooting)
+- [FAQ](docs/10-faq)
-### Build
+## Building the Docs Site
-```bash
-yarn build
-```
+Built with [Docusaurus 2.](https://docusaurus.io/)
-This command generates static content into the `build` directory and can be served using any static
-contents hosting service.
+This project has a hard dependancy on Node16. You will need to make sure that you have the proper
+version of node installed to avoid errors.
-## Community
+- [Install Node16 on Ubuntu](https://joshtronic.com/2021/05/09/how-to-install-nodejs-16-on-ubuntu-2004-lts/)
+- [Install Node16 using brew](https://apple.stackexchange.com/a/207883)
-Feel free to join us on [](https://game.ci/discord) and
-engage with the community.
+This project relies on yarn for package management. You will need to install yarn in order to build
+and test the documentation site.
-## Support us
+- [Official yarn installation docs.](https://classic.yarnpkg.com/lang/en/docs/install)
-GameCI is free for everyone forever.
+1. Install project dependancies
-You can support us at [OpenCollective](https://opencollective.com/game-ci).
+ ```bash
+ yarn install
+ ```
-## Licence
+2. Start a local develpment server
+
+ This command starts a local development server and opens up a browser window. Most changes are
+ reflected live without having to restart the server.
+
+ ```bash
+ yarn start
+ ```
+
+3. Create a build This command generates static content into the `build` directory and can be
+ served using any static contents hosting service.
+
+ ```bash
+ yarn build
+ ```
-This repository is [MIT](./LICENSE) licensed.
+## Meet the Community
+
+Join us on [Discord](https://game.ci/discord) and engage with the growing community of engineers,
+artists, hobbyists, and professionals using GameCI to build, test, and publish their projects
+everyday.
+
+## Support the Team
+
+GameCI is free for everyone forever. You can support the peolpe who make GameCI pssible on
+[OpenCollective](https://opencollective.com/game-ci)
+
+## Licence
-This includes all contributions from the community.
+This repository is [MIT](./LICENSE) licensed. This includes all contributions from the community.
## Sponsors
-[](https://circleci.com?utm_source=game-ci)
+
+ 
+ 
+