From 47dd32cf68277f07d4685278ff9bfead29e62ffc Mon Sep 17 00:00:00 2001 From: Travis Finkenauer Date: Wed, 10 Nov 2021 23:06:36 -0800 Subject: [PATCH] readme: mention master branch deprecation Refers users to the next branch --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 420bb7bf..5c92eb54 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,20 @@ Capstone Engine [![pypi package](https://badge.fury.io/py/capstone.svg)](https://pypi.python.org/pypi/capstone) [![pypi downloads](https://pepy.tech/badge/capstone)](https://pepy.tech/project/capstone) +Deprecation +=========== + +The [`master`](https://github.com/capstone-engine/capstone/tree/master) branch is deprecated. +All forward development should be based on the [`next`](https://github.com/capstone-engine/capstone/tree/next) branch. + +To clone a fresh checkout with the `next` branch: + + git clone -b next https://github.com/capstone-engine/capstone + +To change to the `next` branch in an existing checkout: + + git checkout next + ---- We moved the original historical repo of Capstone from https://github.com/aquynh/capstone to an organization, where we can add more maintainers to the project, and push Capstone development forward.