diff options
| author |   ClarkeCode <33846391+ClarkeCode@users.noreply.github.com> | 2023-02-23 15:50:11 +0100 |
|---|---|---|
| committer |   GitHub <noreply@github.com> | 2023-02-23 15:50:11 +0100 |
| commit | c57c9fea0084bcab41b142465d27b2abed65888b (patch) | |
| tree | 10640ed890ce8032ebb39dffb3ba59787b219321 /docs | |
| parent | 659902727ea838b84b4ea81bfda3b5db3c6e388b (diff) | |
Added contributor quickstart guide (#19)
Diffstat (limited to 'docs')
23 files changed, 120 insertions, 1 deletions
diff --git a/docs/README.md b/docs/README.md index bd40237..b6edf3a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,3 +1,5 @@ # Documentation -[C++ Style Guidlines](styleguide-cpp.md)
\ No newline at end of file +- [Contribution Quickstart Guide](contribution-quickstart-guide.md) +- [Project File Structure](project-file-structure.md) +- [C++ Style Guidlines](styleguide-cpp.md)
\ No newline at end of file diff --git a/docs/contribution-quickstart-guide.md b/docs/contribution-quickstart-guide.md new file mode 100644 index 0000000..153985c --- /dev/null +++ b/docs/contribution-quickstart-guide.md @@ -0,0 +1,117 @@ +# Contributor Quickstart Guide + +## Required Software +- A way to use `git` such as Git Bash or the Windows-Linux Subsystem +- Python 3.x +- Scons +- Godot +- A programming IDE such as Visual Studio Code + +# Software Installation +## 1. [Git Bash](https://git-scm.com/download/win) +- Download and run the [64-bit Windows installer](https://github.com/git-for-windows/git/releases/download/v2.39.2.windows.1/Git-2.39.2-64-bit.exe) + + + +- Leave settings as default + + + + +## 2. [Python](https://www.python.org/downloads/) +- Download the [latest version of Python](https://www.python.org/downloads/) (this includes `pip`) + + + +- Check "Add python.exe to PATH" and use the "Install Now" option + + + + +## 3. Scons +- Open Windows Powershell and run the command `pip install scons` + + + +## 4. [Godot](https://downloads.tuxfamily.org/godotengine/4.0/rc3/) +- Download Godot 4. The current version for the project will be on the [main README](../README.md) page. + + + +- Unzip the Godot executable wherever you prefer to have it + + + +## 5. [Visual Studio Code](https://code.visualstudio.com/download) (IDE) +- For editing the C++ portion of the codebase, you may use any IDE that you are comfortable using +- [Visual Studio Code](https://code.visualstudio.com/download) is a popular choice of IDE + + + +# Project Setup + +1. [Go to the main repository](https://github.com/OpenVic2Project/OpenVic2) page on Github + +2. Get the link to clone the repo + + + +3. Using Git, clone the repo: `git clone git@github.com:OpenVic2Project/OpenVic2.git` + + + +4. Move into the OpenVic2 directory: `cd OpenVic2` + +5. Retrieve submodules: `git submodule update --init --recursive` + + + +6. Create and checkout a new git branch for your changes: `git switch -c my-cool-branch` + - You should give your branch a descriptive name of the changes you intend to make + + + +7. Build the C++ portion of the project by running `scons` in Powershell + - It will take a minute to initially compile. Any future C++ changes only need to recompile the files that were changed and are much faster + + + +8. Run the Godot executable + +9. Select the 'Import' project button + + + +10. Navigate to the `OpenVic2/game/` directory and select the `project.godot` file + + + +11. Select "Import & Edit" + + + +12. This will open the Godot editor! Make your changes as desired and press the "Play" button in the top-right corner to run the game in-editor. + + + + +# Contributing your changes! + +Whenever you are ready to commit your changes follow this process: + +1. Run `git status` to show what files are new or changed + + + +2. Run `git add ...` for each of the modified files + + + +3. Run `git commit -m "A descriptive commit message"` to make a commit with your staged changes + + + +4. Run `git push` to upload your current commits to your working branch + - If you're warned that your branch has no upstream branch, run `git push --set-upstream origin my-cool-branch`, replacing "`my-cool-branch`" with whatever your branch is named in [Part 6 of Project Setup](#project-setup) + +
\ No newline at end of file diff --git a/docs/images/contribution/01-status.png b/docs/images/contribution/01-status.png Binary files differnew file mode 100644 index 0000000..c45b647 --- /dev/null +++ b/docs/images/contribution/01-status.png diff --git a/docs/images/contribution/02-add.png b/docs/images/contribution/02-add.png Binary files differnew file mode 100644 index 0000000..a73d352 --- /dev/null +++ b/docs/images/contribution/02-add.png diff --git a/docs/images/contribution/03-commit.png b/docs/images/contribution/03-commit.png Binary files differnew file mode 100644 index 0000000..3a194e1 --- /dev/null +++ b/docs/images/contribution/03-commit.png diff --git a/docs/images/contribution/04-push.png b/docs/images/contribution/04-push.png Binary files differnew file mode 100644 index 0000000..69557fb --- /dev/null +++ b/docs/images/contribution/04-push.png diff --git a/docs/images/installation/git-bash-dl-page.png b/docs/images/installation/git-bash-dl-page.png Binary files differnew file mode 100644 index 0000000..7176c76 --- /dev/null +++ b/docs/images/installation/git-bash-dl-page.png diff --git a/docs/images/installation/git-bash-finish-installation.png b/docs/images/installation/git-bash-finish-installation.png Binary files differnew file mode 100644 index 0000000..c1204ad --- /dev/null +++ b/docs/images/installation/git-bash-finish-installation.png diff --git a/docs/images/installation/godot-dl-page.png b/docs/images/installation/godot-dl-page.png Binary files differnew file mode 100644 index 0000000..d98d757 --- /dev/null +++ b/docs/images/installation/godot-dl-page.png diff --git a/docs/images/installation/godot-unzip.png b/docs/images/installation/godot-unzip.png Binary files differnew file mode 100644 index 0000000..45eac89 --- /dev/null +++ b/docs/images/installation/godot-unzip.png diff --git a/docs/images/installation/python-dl-page.png b/docs/images/installation/python-dl-page.png Binary files differnew file mode 100644 index 0000000..0d7b6d1 --- /dev/null +++ b/docs/images/installation/python-dl-page.png diff --git a/docs/images/installation/python-installer.png b/docs/images/installation/python-installer.png Binary files differnew file mode 100644 index 0000000..0b7774c --- /dev/null +++ b/docs/images/installation/python-installer.png diff --git a/docs/images/installation/scons-install.png b/docs/images/installation/scons-install.png Binary files differnew file mode 100644 index 0000000..0742005 --- /dev/null +++ b/docs/images/installation/scons-install.png diff --git a/docs/images/installation/vscode-dl-page.png b/docs/images/installation/vscode-dl-page.png Binary files differnew file mode 100644 index 0000000..ff5c176 --- /dev/null +++ b/docs/images/installation/vscode-dl-page.png diff --git a/docs/images/proj-setup/01-git-clone-link.png b/docs/images/proj-setup/01-git-clone-link.png Binary files differnew file mode 100644 index 0000000..6403426 --- /dev/null +++ b/docs/images/proj-setup/01-git-clone-link.png diff --git a/docs/images/proj-setup/02-git-clone.png b/docs/images/proj-setup/02-git-clone.png Binary files differnew file mode 100644 index 0000000..ad542f8 --- /dev/null +++ b/docs/images/proj-setup/02-git-clone.png diff --git a/docs/images/proj-setup/03-submodules.png b/docs/images/proj-setup/03-submodules.png Binary files differnew file mode 100644 index 0000000..1beea2f --- /dev/null +++ b/docs/images/proj-setup/03-submodules.png diff --git a/docs/images/proj-setup/04-new-branch.png b/docs/images/proj-setup/04-new-branch.png Binary files differnew file mode 100644 index 0000000..cddd5e4 --- /dev/null +++ b/docs/images/proj-setup/04-new-branch.png diff --git a/docs/images/proj-setup/05-scons.png b/docs/images/proj-setup/05-scons.png Binary files differnew file mode 100644 index 0000000..125493c --- /dev/null +++ b/docs/images/proj-setup/05-scons.png diff --git a/docs/images/proj-setup/06-import.png b/docs/images/proj-setup/06-import.png Binary files differnew file mode 100644 index 0000000..b5932f4 --- /dev/null +++ b/docs/images/proj-setup/06-import.png diff --git a/docs/images/proj-setup/07-select-project.png b/docs/images/proj-setup/07-select-project.png Binary files differnew file mode 100644 index 0000000..cc22387 --- /dev/null +++ b/docs/images/proj-setup/07-select-project.png diff --git a/docs/images/proj-setup/08-import-edit.png b/docs/images/proj-setup/08-import-edit.png Binary files differnew file mode 100644 index 0000000..d13c279 --- /dev/null +++ b/docs/images/proj-setup/08-import-edit.png diff --git a/docs/images/proj-setup/09-run-project.png b/docs/images/proj-setup/09-run-project.png Binary files differnew file mode 100644 index 0000000..965cca9 --- /dev/null +++ b/docs/images/proj-setup/09-run-project.png |
