From f8ef1c09953c13d938e7578ac8f98647b9bd8b98 Mon Sep 17 00:00:00 2001 From: pancake Date: Mon, 12 Jun 2017 12:32:30 +0200 Subject: [PATCH] Sync go, rust and ocaml --- go/README.md | 24 ++---------------------- go/r2pipe.go | 2 +- ocaml/_oasis | 13 ++++++++++++- rust/README.md | 32 +++++++++++++++++++++++++++++++- 4 files changed, 46 insertions(+), 25 deletions(-) diff --git a/go/README.md b/go/README.md index 53874eb..110011d 100644 --- a/go/README.md +++ b/go/README.md @@ -1,26 +1,6 @@ r2pipe.go ========= -Go module to interact with radare2 - - -## How to use? - -### Code -```go -package test +[![GoDoc](https://godoc.org/github.com/radare/r2pipe-go?status.svg)](https://godoc.org/github.com/radare/r2pipe-go) -import ( - "github.com/radare/radare2-r2pipe/go" -) - -func main() { - r2p, err := r2pipe.NewPipe("malloc://256") -} -``` - -### Compiling -```sh -$ go get -$ go build test.go -``` +Go module to interact with radare2 diff --git a/go/r2pipe.go b/go/r2pipe.go index d010ceb..ed28276 100644 --- a/go/r2pipe.go +++ b/go/r2pipe.go @@ -9,7 +9,7 @@ look like the following snippet: import ( "fmt" - "github.com/radare/radare2-bindings/r2pipe/go/r2pipe" + "github.com/radare/r2pipe-go" ) func main() { diff --git a/ocaml/_oasis b/ocaml/_oasis index 594a76f..8e4ce52 100644 --- a/ocaml/_oasis +++ b/ocaml/_oasis @@ -10,7 +10,7 @@ License: BSD-3-clause OCamlVersion: >= 4.03.0 AlphaFeatures: ocamlbuild_more_args Plugins: META (0.4), DevFiles (0.4) -BuildTools: ocamlbuild +BuildTools: ocamlbuild, ocamldoc Description: Interact with radare2 from within OCaml. @@ -37,3 +37,14 @@ SourceRepository master Type: git Location: https://github.com/fxfactorial/ocaml-radare2.git Browser: https://github.com/fxfactorial/ocaml-radare2 + +Document api + Title: Documentation and API reference for radare2 + Type: ocamlbuild (0.4) + InstallDir: $htmldir/radare2 + PostCommand: cp docs/style.css api.docdir && cp api.docdir/* docs + XOCamlbuildPath: docs + XOCamlbuildModules: src/R2 + Install: true + XOCamlbuildExtraArgs: + "-docflags '-colorize-code -charset utf-8 -hide R2 -hide Pervasives'" \ No newline at end of file diff --git a/rust/README.md b/rust/README.md index 4ea3853..1ca8495 100644 --- a/rust/README.md +++ b/rust/README.md @@ -1 +1,31 @@ -See https://github.com/radare/r2pipe.rs +r2pipe.rs +========= + +| **TravisCI** | [![Build Status](https://travis-ci.org/radare/r2pipe.rs.svg?branch=master)](https://travis-ci.org/radare/r2pipe.rs)| + +The Rust Crate to interact with radare2. +Please check [Documentation](https://radare.github.io/r2pipe.rs) to get +started. + + +TODO +---- +* Support async API +* Support HTTP connectivity +* Add custom r2 start flags for spawn method +* Add plain TCP api +* Better error handling + +## License + +Licensed under either of + + * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) + * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) + +at your option. + +### Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.