Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "suncan"]
path = suncan
url = git@github.com:UBC-Solar/suncan.git
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,14 +67,24 @@ Follow the steps below to fully install, configure, and run Sunlite's RPI-based
To clone the main (production) repository of Sunlite use this command:

```bash
git clone https://github.com/UBC-Solar/sunlite.git
git clone --recurse-submodules https://github.com/UBC-Solar/sunlite.git
cd sunlite
```
**Recommended Everytime you Open Sunlite**
```bash
git pull
git submodule update --init --recursive
cd .\suncan
git pull
cd ..
```

The submodule update is required everytime for **Suncan** submodule changes. Do it everytime to have up to date dbc file.

When doing testing on a RPI, branches can be cloned as well:

```bash
git clone --branch <branch-name> https://github.com/UBC-Solar/sunlite.git
git clone --recurse-submodules --branch <branch-name> https://github.com/UBC-Solar/sunlite.git
cd sunlite
```

Expand Down
Loading