Skip to content

Commit

Permalink
Sync go, rust and ocaml
Browse files Browse the repository at this point in the history
  • Loading branch information
radare committed Jun 12, 2017
1 parent 25f3a51 commit f8ef1c0
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 25 deletions.
24 changes: 2 additions & 22 deletions go/README.md
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion go/r2pipe.go
Original file line number Diff line number Diff line change
Expand Up @@ -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() {
Expand Down
13 changes: 12 additions & 1 deletion ocaml/_oasis
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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'"
32 changes: 31 additions & 1 deletion rust/README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit f8ef1c0

Please sign in to comment.