Skip to content

Commit 66300b2

Browse files
committed
Merge branch 'python-kin-refactor' of github.com:LonghornRacingElectric/simulation_toolkit into python-kin-refactor
2 parents 9270bea + fd7aa5b commit 66300b2

File tree

4 files changed

+237
-14
lines changed

4 files changed

+237
-14
lines changed

README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,54 @@ If this runs without error, skip past this section. If you receive an error, ins
7777
sudo pacman -Su make
7878
```
7979

80+
### Dependencies (git):
81+
82+
Git is required to clone repositories from Github. It's also required for code development and version control.
83+
84+
##### Windows
85+
1. If you already installed Git Bash, this is covered
86+
87+
##### MacOS
88+
1. Make sure you've installed Homebrew from the previous step (make)
89+
90+
2. Install Git from the command line using:
91+
```shell
92+
brew install git
93+
```
94+
95+
##### Linux (Debian-based distros)
96+
1. Run the following command in terminal
97+
```shell
98+
sudo apt-get install git
99+
```
100+
101+
##### Linux (Arch)
102+
1. Run the following command in terminal
103+
```shell
104+
sudo pacman -Su git
105+
```
106+
107+
Once you've installed Git, it still needs to be configured. First, set your name and email (associated with commits). This can be achieved with the following command:
108+
109+
```shell
110+
git config --global user.name "Your Name"
111+
git config --global user.email "you@example.com"
112+
```
113+
114+
### Dependencies (OpenModelica):
115+
116+
Go to the [OpenModelica Website](https://openmodelica.org/). Under "Download", pick your specified operating system. Installation varies across machines, but reach out to code owners if you run into any issues. Note that this process is easiest on Windows and probably most difficult on MacOS (need to install via a Docker container).
117+
118+
##### Arch
119+
1. Run the following commands in terminal
120+
```shell
121+
yay -S openmodelica
122+
yay -S openmodelica-omlibraries
123+
```
124+
Make sure the second checkbox is checked
125+
<center>
126+
<img src="./src/_4_ico/Modelica_Setting.png" width="75%">
127+
</center>
80128
### Dependencies (docker):
81129
82130
Docker isn't required to run workflows locally, but it is highly recommended. Docker containers give a unified runtime environment, making debugging easier with fewer runtime issues.

0 commit comments

Comments
 (0)