From 1f7523ce2b1edac1014d781fc771d5b82568e2f1 Mon Sep 17 00:00:00 2001 From: Andrew Lamoureux Date: Wed, 15 Mar 2017 18:13:07 -0400 Subject: build explanation, windows make files --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 0bb4ee9b..be6c0b47 100644 --- a/README.md +++ b/README.md @@ -12,3 +12,16 @@ If interested in contributing, first please read and sign the [Contribution Lice The issue tracker for this repository tracks not only issues with the source code contained here but also the broader Binary Ninja product. +## Building + +Starting mid March 2017, the C++ portion of this API can be built into a static library (.a, .lib) that binary plugins can link against. Use Makefile on MacOS, Linux, and Windows mingw environments, and Makefile.win (nmake file) for Windows Visual Studio environment (nmake -f). + +The compiled API contains names and functions you can use from your plugins, but most of the implementation is missing until you link up against libbinaryninjacore.dylib or libbinaryninjacore.dll (via import file libbinaryninjacore.lib). See the ./examples. + +Since BinaryNinja is a 64-bit only product, ensure that you are using a 64-bit compiling and linking environment. Errors on windows like LNK1107 might indicate that your bits don't match. + +## Examples + +* bin-info is a standalone executable that prints some information about a given binary to stdout +* breakpoint is a plugin that allows you to select a region within an x86 binary and use the context menu to fill it with breakpoint bytes +* print_syscalls is a standalone executable that prints the syscalls used in a given binary -- cgit v1.3.1 From 844abdd0ef9eab973845020b3571af7771398183 Mon Sep 17 00:00:00 2001 From: Jordan Wiens Date: Tue, 11 Apr 2017 11:43:40 -0400 Subject: add slack signup to readme --- README.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index be6c0b47..2c9da902 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +[![slack](https://binaryninja-slack-hwwdinrdce.now.sh/badge.svg)](https://binaryninja-slack-hwwdinrdce.now.sh/) + # Binary Ninja API This repository contains documentation and source code for the [Binary Ninja](https://binary.ninja/) reverse engineering platform API. -- cgit v1.3.1 From 860280bf77f0a79da442e76313252129e4789686 Mon Sep 17 00:00:00 2001 From: Jordan Date: Thu, 13 Apr 2017 17:13:07 -0400 Subject: Update README.md add note about branches --- README.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 2c9da902..c089636a 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,10 @@ This repository contains documentation and source code for the [Binary Ninja](https://binary.ninja/) reverse engineering platform API. +## Branches + +Please note that the [dev](/Vector35/binaryninja-api/tree/dev/) branch tracks changes on the `dev` build of binary ninja and is generally the place where all pull requests should be submitted to. However, the [master](/Vector35/binaryninja-api/tree/master/) branch tracks the `stable` build of Binary Ninja which is the default version run after installation. Online [documentation](https://api.binary.ninja/) tracks the stable branch. + ## Contributing Public contributions are welcome to this repository. All the API and documentation in this repository is licensed under an MIT license, however, the API interfaces with a closed-source commercial application, [Binary Ninja](https://binary.ninja). -- cgit v1.3.1 From cf676d7dd533ab4d42e602f9451e3ae2093408ac Mon Sep 17 00:00:00 2001 From: Jordan Wiens Date: Thu, 25 May 2017 11:38:17 -0400 Subject: typo in CLA section --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index c089636a..bfa453d0 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Please note that the [dev](/Vector35/binaryninja-api/tree/dev/) branch tracks ch Public contributions are welcome to this repository. All the API and documentation in this repository is licensed under an MIT license, however, the API interfaces with a closed-source commercial application, [Binary Ninja](https://binary.ninja). -If interested in contributing, first please read and sign the [Contribution License Agreement](https://binary.ninja/cla.pdf). Next, email a your signed copy of the license to info@binary.ninja along with your github username. Once that email is confirmed, any pending pull requests will be evaluated for inclusion. +If interested in contributing, first please read and sign the [Contribution License Agreement](https://binary.ninja/cla.pdf). Next, email your signed copy of the license to info@binary.ninja along with your github username. Once that email is confirmed, any pending pull requests will be evaluated for inclusion. ## Issues -- cgit v1.3.1