diff --git a/README.md b/README.md index 610c8c72..9e07441f 100644 --- a/README.md +++ b/README.md @@ -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