Merge pull request #274 from fixstars/feature/update-readme

update readmes
fixstars · May 23, 2024 · d606330 · d606330
2 parents 4f6d04f + 358d17b
commit d606330
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/BUILD-Linux.md b/BUILD-Linux.md
@@ -17,8 +17,10 @@ curl -sL https://github.com/halide/Halide/releases/download/v16.0.0/Halide-16.0.
 
 We recommend to setup libjpeg-turbo, libpng and zlib by [vcpkg](https://vcpkg.io/).
 
+In root folder of `ion-kit` run:
+
 ```sh
-vcpkg install libjpeg-turbo libpng zlib
+vcpkg install
 ```
 
 ## 2. Build

diff --git a/BUILD-Windows.md b/BUILD-Windows.md
@@ -13,8 +13,10 @@ For Halide, please find latest binary release [here](https://github.com/halide/H
 
 We recommend to setup libjpeg-turbo, libpng and zlib by [vcpkg](https://vcpkg.io/).
 
+In root folder of `ion-kit` run:
+
 ```sh
-vcpkg install libjpeg-turbo:x64-windows-static libpng:x64-windows-static zlib:x64-windows-static
+vcpkg install --triplet x64-windows-static
 ```
 
 ## 2. Build

diff --git a/README.md b/README.md
@@ -12,6 +12,8 @@ You can also run the pipeline immediately on your host machine.
 
 You can download the official binary package from [release](https://github.com/fixstars/ion-kit/releases).
 
+If you wish to build using our repository, please use branch `release/v1` which utilizes Halide16.  We are currently working on migrating to Halide17 on the `main` branch.
+
 ```c++
 #include <ion/ion.h>
-Original file line number
+Diff line change
@@ Expand Up @@
     You can download the official binary package from [release](https://github.com/fixstars/ion-kit/releases).
+    If you wish to build using our repository, please use branch `release/v1` which utilizes Halide16.  We are currently working on migrating to Halide17 on the `main` branch.
     ```c++
     #include <ion/ion.h>
@@ Expand Down @@