Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: specify release version branch #128

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
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
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,24 @@ The PC simulator is cross platform. **Windows, Linux and OSX** are supported, h
Clone the PC project and the related sub modules:

```
git clone --recursive https://github.com/littlevgl/pc_simulator_sdl_eclipse.git
git clone https://github.com/littlevgl/pc_simulator_sdl_eclipse.git
```

### Checkout your LVGL version

You are viewing this README on the LVGL `master` branch.

- [Click here to browse the `release/v8.3` branch.](https://github.com/lvgl/lv_port_pc_eclipse/tree/release/v8.3)
- [Click here to see all branches.](https://github.com/lvgl/lv_port_pc_eclipse/branches)

If your project will not be using the LVGL `master` branch, checkout the branch that corresponds to the version of LVGL you will be using. For example, if your project uses LVGL v8.3, then you need to checkout the corresponding branch of **this** repository:
```
git checkout release/v8.3
```

After checking out your branch, or staying on `master`, update your local submodule dependencies:
```
git submodule update --init --recursive
```

### Install SDL
Expand Down