Updated documentation

miketheprogrammer · miketheprogrammer · commit 17635a400017 · 2014-10-24T10:36:36.000-04:00
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@ go-thrust
 =========
 Current Version 0.2.0
 
-Official GoLang Thrust Client for Thrust (https://github.com/breach/thrust) to be used in Breach.cc(http://breach.cc) via Official Go Implementation @ (http://github.com/miketheprogrammer/breach-go).
+Official GoLang Thrust Client for Thrust (https://github.com/breach/thrust)
 
 Running DEMO binary on OSX 10.9 or Linux (This is just for the demo, Thrust as it stands now is really a Library to be used in other applications.)
 ==================
@@ -52,7 +52,7 @@ DOCUMENTATION
 
 Roadmap to v1.0 :
 ================
-Please note Complete Support will never be toggled until Thrust core is stable.
+Please note Complete Support *may* not be toggled until Thrust core is stable.
 
 - [X] Queue Requests prior to Object being created to matain a synchronous looking API without the need for alot of state checks
 - [ ] Remove overuse of pointers in structs where modification will not take place
@@ -109,11 +109,7 @@ Using Go-Thrust as a Library and bundling your final release
 ==========================
 To use go-thrust as a library, simple use the code in the same way you would use any GoLang library.
 
-When prepping your releases, please try to stick to the contract of our release folder, view MakeFile tag build.release for an example.
-
-However if you want to make your own folder structure, feel free to modify the spawn package and relevant tools files to suit your needs.
-
-As long as spawn, can successfully install, find, and run the Thrust Core binaries, then you are golden.
+- More info to come on Prepping releases.
 
 
 
diff --git a/doc/spawn/README.md b/doc/spawn/README.md
@@ -5,12 +5,6 @@
 
 ## Usage
 
-#### func  ApplySymlinks
-
-```go
-func ApplySymlinks()
-```
-
 #### func  Bootstrap
 
 ```go
diff --git a/html/index.html b/html/index.html
diff --git a/public/index.html b/public/index.html
@@ -0,0 +1,13 @@
+<html>
+<head>
+<title>Thrust DEMO</title>
+<style></style>
+</head>
+<body>
+<h1 class="header">
+Welcome to the Thrust Demo.
+<iframe id="docview" width="800px" height="768px">
+</iframe>
+</h2>
+</body>
+</html>
diff --git a/spawn/helper_darwin.go b/spawn/helper_darwin.go
@@ -59,11 +59,17 @@ func Bootstrap() {
 
 }
 
+/*
+executableNotExist checks if the executable does not exist
+*/
 func executableNotExist() bool {
 	_, err := os.Stat(GetExecutablePath())
 	return os.IsNotExist(err)
 }
 
+/*
+prepareExecutable dowloads, unzips and does alot of other magic to prepare our thrust core build.
+*/
 func prepareExecutable() {
 	path := downloadFromUrl(GetDownloadUrl(), common.THRUST_VERSION)
 	//unzip(strings.Replace("/tmp/$V", "$V", common.THRUST_VERSION, 1), GetThrustDirectory())
@@ -72,10 +78,13 @@ func prepareExecutable() {
 	os.Rename(GetThrustDirectory()+"/ThrustShell.app/Contents/MacOS/ThrustShell", GetThrustDirectory()+"/ThrustShell.app/Contents/MacOS/"+common.ApplicationName)
 	os.Rename(GetThrustDirectory()+"/ThrustShell.app", GetThrustDirectory()+"/"+common.ApplicationName+".app")
 
-	ApplySymlinks()
+	applySymlinks()
 }
 
-func ApplySymlinks() {
+/*
+ApplySymLinks exists because our unzip utility does not respect deferred symlinks. It applies all the neccessary symlinks to make the thrust core exe connect to the thrust core libs.
+*/
+func applySymlinks() {
 	fmt.Println("Applying Symlinks")
 	fmt.Println(
 		os.Remove(GetAppDirectory()+"/Contents/Frameworks/ThrustShell Framework.framework/Versions/Current"),
