docs

README.md

@@ -1,14 +1,55 @@
-iguana is easy to build. just make sure you have the dev versions of openssl and curl installed
+iguana is easy to build. start by cloning (or downloading) this repo
 
-gcc -O2 -o iguana *.c InstantDEX/*.c -lssl -lcrypto -lpthread -lcurl -lm
+DEPENDENCIES
+for native (unix, osx): just make sure you have the dev versions of openssl and curl installed:
+    sudo apt-get install libcurl4-gnutls-dev libcurl4-openssl-dev
 
-the above builds native iguana on unix/osx
+for native (win32, win64): this still needs to be ported, pthreads is the only non-native windows system functions being used. OS_portable.c and OS_nonportable.c have the few windows functions that are needed to be ported and also a compile/link process needs to be done. I think cygwin or even mingw would work, alternatively compiling the codebase with VS shouldnt be too much work. until this is done the instructions below about m_win32 and m_win64 wont actually work
 
-then just run it and browse to http://127.0.0.1:7778/?method
+for chrome app:
-you can use the gui to find the URL you need for an operation, then add /json to get just the json and not the entire webpage. alternatively a POST (ie via curl --data) with the JSON request will just return json
+    you need to make sure the nacl sdk is properly installed and you are able to build the examples
+    Now you will need to get the external libs, which can be built from scratch using naclports or
+    there use the reference builds of libssl.a, libcrypto.a, libcurl.a and libz.a in the SuperNET/libs
+    You can just copy those over into $(NACL_SDK_ROOT)/lib/pnacl
+
+ONETIME
+Now you are ready to build.
+I try to make the build process as simple as possible, so there are no autoconf, autoreconf, configure, cmake, make, to get properly installed and running and run, etc. You do need a C compiler, like gcc
+
+The first time you need to build libcrypto777.a and to do that you need to run:
+For unix: ./m_onetime m_unix
+For osx: ./m_onetime m_osx
+For win32: ./m_onetime m_win32
+For win64: ./m_onetime m_win64
+
+(RE)BUILD
+Once libcrypto777.a is built, you can build the agents.
+For pnacl: ./m_pnacl
+For unix: ./m_unix
+For osx: ./m_osx
+For win32: ./m_win32
+For win64: ./m_win64
+
+The m_(OS) is a standard I follow and should be self explanatory. within each is usually just a few lines, ie compile all the .c files and link with the standard libs.
+
+To build just iguana, you can cd into SuperNET/iguana and do ./m_unix (or ./m_osx, ...)
+
+./m_clean will remove the files created from the building
+
+RUNNING
+The native versions are command line applications: agents/iguana {JSON}
+The chrome app pexe requires that the chrome is launched with a command line parameter (tools/chrome.localhost) and then browse to http://127.0.0.1:7777 to see the pexe
+
+SUPERUGLYGUI
+Once iguana is running, you can see the superuglyGUI at http://127.0.0.1:7778/?method
+by submitting API calls using the forms, you will see it go to some specific URL. You can also do a programmatic GET request to http://127.0.0.1:7778/api/<path to apicall>
 
 http://127.0.0.1:7778/ramchain/block/height/0 -> full webpage
 
 http://127.0.0.1:7778/json/ramchain/block/height/0 -> JSON only
 
-the superugly GUI is not stateless, there is a default coin that is used for any coin based API.
+curl --url "http://127.0.0.1:7778/ramchain/BTCD/block/height/0" --> full webpage returned (probably not what you want)
+curl --url "http://127.0.0.1:7778/json/ramchain/BTCD/block/height/0" --> returns just the json object from the api call
+
+Internall, all paths convert the request into a standard SuperNET JSON request. you can use a POST command to directly submit such JSON requests:
+curl --url "http://127.0.0.1:7778/?" --data "{\"agent\":\"ramchain\",\"method\":\"block\",\"coin\":\"BTCD\",\"height\":0}"