Add development branch instructions (intel#91)

.github/workflows/github-ci.yml

@@ -8,11 +8,13 @@ on:
   pull_request:
     branches:
       - main
+      - development
       - "[0-9]+.[0-9]+.[0-9]+" # Run on release branch, e.g. 1.2.0
   # Run when protected branches are pushed to, e.g. via merge
   push:
     branches:
       - main
+      - development
       - "[0-9]+.[0-9]+.[0-9]+" # Run on release branch, e.g. 1.2.0
 
   # Manually run this workflow on any specified branch.

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Pull Requests
 
-Intel HEXL welcomes pull requests from external contributors to the `main` branch.
+Intel HEXL welcomes pull requests from external contributors to the `development` branch.
 
 Before contributing, please run
 ```bash

README.md

@@ -78,7 +78,15 @@ For convenience, they are listed below:
 | HEXL_TREAT_WARNING_AS_ERROR   | ON / OFF | OFF     | Set to ON to treat all warnings as error                    |
 
 ### Compiling Intel HEXL
-To compile Intel HEXL from source code, first clone the repository and change directories to the where the source has been cloned.
+To compile Intel HEXL from source code, first clone the repository. For latest changes, checkout the `development` branch. For more stable code, checkout the `main` branch, which will store the latest release.
+```bash
+# For development
+git clone --branch development https://github.com/intel/hexl
+# For latest release
+git clone --branch main https://github.com/intel/hexl
+```
+Then change directories to the where the source has been cloned, e.g. via `cd hexl`
+
 #### Linux and Mac
 The instructions to build Intel HEXL are common to Linux and MacOS.
 

port/hexl/portfile.cmake

@@ -4,7 +4,7 @@ vcpkg_fail_port_install(ON_ARCH "x86" "arm" "arm64")
 vcpkg_from_github(
     OUT_SOURCE_PATH SOURCE_PATH
     REPO intel/hexl
-    HEAD_REF main
+    HEAD_REF development
 )
 
 set(VCPKG_BUILD_TYPE release)