Skip to content

Commit

Permalink
Update Intro.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Darsh-Parikh authored Apr 3, 2024
1 parent 920745e commit a10d541
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions Manuals/Intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ In this exercise, you will get to explore the basics of programming on IntelliSa
You'll notice a bunch of functions in the Training directory
* `Drivers/` is for Hardware specific header files. Here live macros to help program things on the lowest layer of IntelliSat.
* `Manuals/` is where certain IntelliSat and Orbital Platform guides are, as well as instructions for CubeIDE
* `Startup/` is where the
* `Startup/` is where the startup script is located. It is an Assembly script that runs when the computer startups up. It is what called IntelliSat `main()`
* `Src/` is where all the source code for IntelliSat is
* `system_config/` and `tools` is where pre-existing IntelliSat code is
* `playground/` is where you'd work. In particular you'll work on branch_main.c
Expand All @@ -19,7 +19,7 @@ You will also notice some `.ld` files. Those are *Linker Scripts*, important for
# What is `branch_main()`
Normally C programs have a `main()` function where all the code goes. But putting all the test code in the main function runs into an issue:
- Git doesn't like when 2 people change the exact same function. It won't merge them
So if `main()` was edited by 2 seperate people in seperate branches with their test code, it would never merge. While there are many ways to work around this, our initial approach was:
So if `main()` was edited by 2 separate people in separate branches with their test code, it would never merge. While there are many ways to work around this, our initial approach was:
```
1. main() will call branch_main(). This function won't be defined initially.
2. Whenever a new branch is created, the branch_main() there will be used for all sorts of testing
Expand Down Expand Up @@ -53,4 +53,4 @@ You might wonder how you'll program any of this. Assuming you basic comfort with
- Human Interfaces: [IntelliSat Google Drive Documentation](https://drive.google.com/drive/folders/1zpdk_iLhg8gtlJ3CGYCjlBHBFf4T6uPW?usp=sharing)
Read these carefully, especially the Usage Guide.

As an extra detail, *Human Interfaces* are just some of the many systems within IntelliSat. If you're curious about the others, give the IntelliSat Software Architecture a look: [IntelliSat Software Architecture](https://drive.google.com/file/d/1QEXlteOZaiWoB1dDf9I8SrOeJhTq2IYE/view?usp=sharing)
As an extra detail, *Human Interfaces* are just some of the many systems within IntelliSat. If you're curious about the others, give the IntelliSat Software Architecture a look: [IntelliSat Software Architecture](https://drive.google.com/file/d/1QEXlteOZaiWoB1dDf9I8SrOeJhTq2IYE/view?usp=sharing)

0 comments on commit a10d541

Please sign in to comment.