summaryrefslogtreecommitdiff
path: root/docs/tutorial/contents.md
diff options
context:
space:
mode:
authorParker Burnett <burnettparker@gmail.com>2022-07-11 17:27:49 -0700
committerGitHub <noreply@github.com>2022-07-11 20:27:49 -0400
commit3503163a640cd19f1788a58ec5abb7a57ea53b2c (patch)
tree1c6bb3b7b375818b9f5f91a094ed5b27d5a9f56f /docs/tutorial/contents.md
parent54957f8735051610ba97d40467dd008fa1870ca2 (diff)
Adding Git information to tutorial (#862)
* Adding an intro to git with helpful commands for someone unfamiliar with git. Co-authored by: EllipticEllipsis <elliptic.ellipsis@gmail.com> * Adding an intro to git with helpful commands for someone unfamiliar with git. Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com> * ovl_Obj_Y2lift decompiled (#856) * ovl_Obj_Y2lift decompiled * format * pr review fixes * clean up Co-authored-by: SonicDcer <noreply@github.com> * Formating files and moving contributing.md Also fixes links. * Adding an intro to git with helpful commands for someone unfamiliar with git. formating files too Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com> * pr fixes Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com> Co-authored-by: Alejandro Asenjo <96613413+sonicdcer@users.noreply.github.com> Co-authored-by: SonicDcer <noreply@github.com>
Diffstat (limited to 'docs/tutorial/contents.md')
-rw-r--r--docs/tutorial/contents.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/docs/tutorial/contents.md b/docs/tutorial/contents.md
index 0435becb4..bb703f5c7 100644
--- a/docs/tutorial/contents.md
+++ b/docs/tutorial/contents.md
@@ -1,12 +1,15 @@
# Getting started
## [Introduction to decomp](introduction.md)
+
- What we are doing
- Structure of the code
## Pre-decompilation
+
+- [Introduction to git](intro_to_git.md)
- Building the repo (follow the instructions in the [README.md](../../README.md))
-- Most of us use VSCode. Some useful information is [here](vscode.md).
+- Most of us use VSCode. Some useful information is [here](vscode.md).
<!-- Feel free to document Emacs/Vi/Sublime/whatever if you're familiar with them -->
- Choosing a first actor (You want something small that has simple interactions with the environment. A simple NPC can also work, and is what we will use as an illustration for most of the tutorial. There is a collection of actors we think are suitable for beginners on the spreadsheet or Trello)
@@ -35,15 +38,17 @@
- [Documenting a decompiled file](documenting.md)
## [Object Decompilation](object_decomp.md)
+
- Object files
- How we decompile objects
## After Decompilation
-- See the [CONTRIBUTING.md](../../CONTRIBUTING.md) for most of the details for submitting PRs. Remember to format again after making adjustments from reviews!
+- See the [CONTRIBUTING.md](../CONTRIBUTING.md) for most of the details for submitting PRs. Remember to format again after making adjustments from reviews!
- More information about specific preparations is in [this document](merging.md).
## Appendices
+
- [Types, Structs and Padding](types_structs_padding.md) (a miscellany of useful stuff)
- [Advanced control flow](advanced_control_flow.md) (an example of a more complex function which mips2c is not so good at)
- [Using the diff script and the permuter](diff_and_permuter.md) (using the diff script and the permuter to match something)