aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTravis Finkenauer <tmfinken@gmail.com>2021-11-10 23:06:36 -0800
committerTravis Finkenauer <tmfinken@gmail.com>2021-11-10 23:06:36 -0800
commit47dd32cf68277f07d4685278ff9bfead29e62ffc (patch)
tree54b47b21c62fd175513bf50265f982402c6ce36f
parent0472b219e3f0fdf5903aa6ff55cc2df1e6911d6e (diff)
downloadcapstone-47dd32cf68277f07d4685278ff9bfead29e62ffc.tar.gz
readme: mention master branch deprecation
Refers users to the next branch
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
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.