aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 25 insertions, 1 deletions
diff --git a/README.md b/README.md
index 1a61b948..5c92eb54 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,30 @@ 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.
+
+Our new home is https://github.com/capstone-engine/capstone
+
+Nov 8th, 2021.
+
+----
+
Capstone is a disassembly framework with the target of becoming the ultimate
disasm engine for binary analysis and reversing in the security community.
@@ -27,7 +51,7 @@ Capstone offers some unparalleled features:
Ruby, C#, NodeJS, Java, GO, C++, OCaml, Lua, Rust, Delphi, Free Pascal & Vala
(ready either in main code, or provided externally by the community).
-- Native support for all popular platforms: Windows, Mac OSX, iOS, Android,
+- Native support for all popular platforms: Windows, macOS, iOS, Android,
Linux, \*BSD, Solaris, etc.
- Thread-safe by design.