From fc6e4ad133ea21f9b95ac4a8d8a1c27a329a6adf Mon Sep 17 00:00:00 2001 From: "J.P. Hutchins" Date: Tue, 29 Aug 2023 15:44:23 -0700 Subject: [PATCH 1/2] docs: specify release version branch --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 610c8c72..a7c0220d 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,21 @@ 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 + +By default the repository will be on `master`. + +Checkout the branch that corresponds to the version of LVGL you will be using. For example, if your project uses LVGL v8.0 then you need to checkout the corresponding release branch of this repository: +``` +git checkout release/v8.0 +``` + +After specifying your version, update your local the submodule dependencies specific to your version: +``` +git submodule update --init --recursive ``` ### Install SDL From 2cedd4b13f33faafc44fc52e5fc4f5a5ddf02073 Mon Sep 17 00:00:00 2001 From: "J.P. Hutchins" Date: Thu, 31 Aug 2023 17:04:39 -0700 Subject: [PATCH 2/2] docs: link to v8.3 and branches; update language to v8.3; clarify language --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a7c0220d..9e07441f 100644 --- a/README.md +++ b/README.md @@ -26,14 +26,17 @@ git clone https://github.com/littlevgl/pc_simulator_sdl_eclipse.git ### Checkout your LVGL version -By default the repository will be on `master`. +You are viewing this README on 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.0 then you need to checkout the corresponding release branch of this repository: +- [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.0 +git checkout release/v8.3 ``` -After specifying your version, update your local the submodule dependencies specific to your version: +After checking out your branch, or staying on `master`, update your local submodule dependencies: ``` git submodule update --init --recursive ```