summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorcoco875 <59367621+coco875@users.noreply.github.com>2024-08-23 02:20:13 +0200
committerGitHub <noreply@github.com>2024-08-22 18:20:13 -0600
commite135178097f416bc54e36058e10d9b1c013929fd (patch)
tree0903c79b59ed716497e55618631d5e76611fe032 /docs
parent3781ce2830a143df855003b65fe069d2e26215d9 (diff)
Update from decomp (#34)
* Update menus.c (#634) * Update common_data.yml (#635) * Renames for screenId and other changes (#636) * screenId renames * Rename surface map to collision mesh (#637) * Rename some stack vars (#638) * Fix syntax error (#639) * Rename some stack vars * Update collision.c * Collision Documentation (#640) * Collision related renames * update doxygen (#649) * change bool (#644) * Update (#642) * Delete trig_tables_bss.c (#650) * fix typo audio (#656) * fix typo src actor (#657) * fix typo include (#658) * fix course (#659) * fix typo debug (#660) * fix typo data (#661) * Update common_structs.h * replace number with const (#665) * fix typo buffers (#655) * fix typo buffers * tweak ld file * rename to sMemoryPool * add a warning --------- * fix typo src (#654) * fix typo src * fix non matcing * Update code_80091750.c --------- * fix typo racing (#653) * fix typo racing * get it match * replace G_LINE3D to G_QUAD --------- * fix typo src (#652) * fix ending typo (#651) * Action more info when it doesn't match and fix first diff (#662) * Update linux-compile.yml * fix first-diff * Update first-diff.py --------- * document texture of kart (#663) * document texture of kart * change screenPlayerId to screenId * some documentation around object * Revert "some documentation around object" This reverts commit cbb39078e036bf2a417bed67359e910213acab28. * more rename --------- * Make evaluate_collision_players_palm_tree better (#667) This matches just the same as before, but using those two casts instead of shifts seems more likely to be accurate to the original source code Signed-off-by: Gabriel Ravier <gabravier@gmail.com> * add fedora instruciton (#666) * start documenting animation (#668) * start documenting animation * Update course_data.c * change comment * fix error of compilation * fix error of compilation * Update animation.c
Diffstat (limited to 'docs')
-rw-r--r--docs/basics/compiling.md10
-rw-r--r--docs/basics/controlflow.md2
2 files changed, 11 insertions, 1 deletions
diff --git a/docs/basics/compiling.md b/docs/basics/compiling.md
index efd1ed59d..1cfd50c94 100644
--- a/docs/basics/compiling.md
+++ b/docs/basics/compiling.md
@@ -13,10 +13,20 @@ To add submodules run `git submodule update --init --recursive` after cloning.
Run `make assets` to extract assets.
# Linux
+
+### Ubuntu
+
```bash
sudo apt install cmake build-essential pkg-config git binutils-mips-linux-gnu python3 zlib1g-dev libaudiofile-dev libcapstone-dev
```
+### Fedora
+
+```bash
+sudo dnf install make automake gcc gcc-c++ kernel-devel cmake pkg-config git python3 zlib-devel audiofile-devel capstone
+```
+and install [gcc toolchain of libdragon](https://github.com/DragonMinded/libdragon/releases/tag/toolchain-continuous-prerelease) and add `export PATH="/opt/libdragon/bin:$PATH"` to ~/.bashrc
+
### Arch
```bash
diff --git a/docs/basics/controlflow.md b/docs/basics/controlflow.md
index 1790244c8..01af022b3 100644
--- a/docs/basics/controlflow.md
+++ b/docs/basics/controlflow.md
@@ -10,7 +10,7 @@ After boot, the game begins by setting up its four threads; [idle](@ref thread1_
The [idle thread](@ref thread1_idle) allows the cpu to sleep. Without it, if at any time execution of all threads were paused, the cpu would never be able to continue. The idle thread is active if all the other threads are paused.
-As such, the [idle thread](@ref thread1_idle) runs the following loop: `while(TRUE);` (it runs in a perpetual loop of nothing; sleep). In mips assembly it looks like this:
+As such, the [idle thread](@ref thread1_idle) runs the following loop: `while(true);` (it runs in a perpetual loop of nothing; sleep). In mips assembly it looks like this:
```
.L800005B8:
b .L800005B8