Skip to content

README cleanup #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
blrhc wants to merge 1 commit into
base: master
Choose a base branch
from
Open

README cleanup #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# SuperNET_API
# SuperNET API

Make sure you have Google Chrome, Chromium has different [instructions](http://askubuntu.com/questions/510056/how-to-install-google-chrome).
Make sure you have [Google Chrome](https://www.google.com/chrome/), Chromium has different [instructions](http://askubuntu.com/questions/510056/how-to-install-google-chrome).

Launch Chrome with `--allow-nacl-socket-api=localhost` command line arg.

Expand All @@ -22,17 +22,17 @@ gcc -o SNapi SNapi.c plugins/utils/cJSON.c -lnanomsg -lm

You can change any of the HTML or JS files and just refresh to test it. After the first clone, just do a git pull and refresh the page.

To recompile the pexe files from scratch, you need to setup a nacl_sdk toolchain (https://developer.chrome.com/native-client/sdk/download) and copy the toolchain directory into the SuperNET_API directory. From there make will recompile, make serve will recompile and launch httpd.py localhost server.
To recompile the pexe files from scratch, you need to setup a [nacl_sdk toolchain](https://developer.chrome.com/native-client/sdk/download) and copy the toolchain directory into the SuperNET_API directory. From there make will recompile, make serve will recompile and launch httpd.py localhost server.

There are five ways of accessing the SuperNET_API:

* via JS function bindings that will send JSON to SuperNET core and get a JSON return back
* via SNapi to send in a JSON request to SuperNET core and it will print to stdout the JSON return
* from SuperNET console
* using ./BitcoinDarkd SuperNET '{\<json request\>}'
* using `./BitcoinDarkd SuperNET '{\<json request\>}'`
* via C code that is linked into the SuperNET_API itself

On unix systems, you can use ./m_unix to build a standalone SuperNET, SNapi and BitcoinDarkd. It shares the same codebase, but on most unix (or mac osx) systems it will be 64bit code vs the 32bit bytecodes and of course an entirely different toolchain, so there could be subtle differences in behavior other than the ~2x performance the native code will get.
On unix systems, you can use `./m_unix` to build a standalone SuperNET, SNapi and BitcoinDarkd. It shares the same codebase, but on most unix (or mac osx) systems it will be 64bit code vs the 32bit bytecodes and of course an entirely different toolchain, so there could be subtle differences in behavior other than the ~2x performance the native code will get.

The nanomsg comms between the native and pnacl should be compatible as long as control messages are not used and the transports are limited to inproc, ipc and tcp.

Expand Down