From efc218a7c5bb0e57747057dba57e80959899cc83 Mon Sep 17 00:00:00 2001 From: Evan Pratten Date: Sat, 19 Mar 2022 11:49:23 -0400 Subject: [PATCH] add dev env docs --- docs/development-environment.md | 42 ++++++++++++++++++++++++++++ docs/getting-started.md | 5 ++++ docs/infrastructure-overview.md | 1 + game/game_logic/src/asset_manager.rs | 0 4 files changed, 48 insertions(+) create mode 100644 docs/infrastructure-overview.md create mode 100644 game/game_logic/src/asset_manager.rs diff --git a/docs/development-environment.md b/docs/development-environment.md index f71241a4..144b42ba 100644 --- a/docs/development-environment.md +++ b/docs/development-environment.md @@ -1 +1,43 @@ # Development Environment + +## Prerequisite Tooling + +On all systems, you must have [Rust](https://www.rust-lang.org/tools/install), [git](https://git-scm.com/), and [cmake](https://cmake.org/download/) installed. + +### Additional Dependencies for Linux + +Linux systems require some additional development headers: + +**Ubuntu:** + +```sh +sudo apt install libasound2-dev mesa-common-dev libx11-dev libxrandr-dev libxi-dev xorg-dev libgl1-mesa-dev libglu1-mesa-dev +``` + +**Fedora:** + +```sh +sudo dnf install alsa-lib-devel mesa-libGL-devel libX11-devel libXrandr-devel libXi-devel libXcursor-devel libXinerama-devel +``` + +## Cloning the Repository + +If you are using [GitHub Desktop](https://desktop.github.com/) or have a [GitKraken](https://www.gitkraken.com/) Pro license, just clone this repo as usual. + +If you are cloning via the CLI, you will need an additional step to ensure our forked dependencies are pulled in correctly: + +```sh +git clone https://github.com/Ewpratten/ludum-dare-50 +cd ludum-dare-50 +git submodule update --init --recursive +``` + +## First Build + +We make heavy use of `cargo` to handle dependency management and build configuration. To build the game, just run: + +```sh +cargo build +``` + +This will take quite a while on first build as it will download all dependencies and compile them locally. diff --git a/docs/getting-started.md b/docs/getting-started.md index bad55622..0367146c 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1 +1,6 @@ # Getting Started + +This section covers the steps needed to start working with the game repository. + +- [Steps for developers](development-environment.md) +- [Steps for artists](artist-information.md) diff --git a/docs/infrastructure-overview.md b/docs/infrastructure-overview.md new file mode 100644 index 00000000..526e7b15 --- /dev/null +++ b/docs/infrastructure-overview.md @@ -0,0 +1 @@ +# Infrastructure Overview diff --git a/game/game_logic/src/asset_manager.rs b/game/game_logic/src/asset_manager.rs new file mode 100644 index 00000000..e69de29b