Improve DevDocs

.gitignore

@@ -6,6 +6,7 @@
 # Folders
 _obj
 _test
+/tmp/
 
 # Architecture specific extensions/prefixes
 *.[568vq]
@@ -21,6 +22,7 @@ _testmain.go
 
 *.exe
 *.gob
+*.gob.new
 *.bolt
 
 /conf.json

README.md

@@ -20,12 +20,12 @@ Development
 
 You'll need to perform the following steps to get a basic server running:
 
+  1. Install [gosl](https://github.com/daviddengcn/gosl) (`go get github.com/daviddengcn/gosl`).
   1. Create a basic `conf.json` file, limiting the crawler to a one minute run: `{ "crawler": { "due_per_run": "1m" } }`
-  1. Run the package finder: `go run tocrawl/*.go`
-  1. Run the crawler: `go run crawler/*.go`
-  1. Merge the crawled docs: `go run mergedocs/*.go`
-  1. Run the indexer: `go run indexer/*.go`
-  1. Run the server: ` go run server/*.go`
+  1. Create the data dir: `mkdir -p data/docs`
+  1. Install dependencies: `./scripts/install.gs`
+  1. Run the crawler: `./scripts/crawler.gs`
+  1. Run the server: `./scripts/server.gs`
   1. Visit [http://localhost:8080](http://localhost:8080) in your browser
 
 

conf.json.template

@@ -1,32 +1,32 @@
 {
-    web: {
-        // addr: ":8080"
-        // root: "./server/"
-	// loadtemplatepass: ""
-	// autoloadtemplate: false
-    }
+  "web": {
+    //"addr": ":8080",
+    //"root": "./server/",
+    //"loadtemplatepass": "",
+    //"autoloadtemplate": false
+  },
 
-    back: {
-        // dbroot: "./data/"
-    }
+  "back": {
+    //"dbroot": "./data/"
+  },
 
-    crawler: {
-        // due_per_run: "1h"
-        // godoc: true
-        // github_update: true
-		// noncrawl_hosts: []
-		// github: {
-		// 	clientid: ""
-		// 	clientsecret: ""
-		// }
-    }
+  "crawler": {
+    //"due_per_run": "1h",
+    //"godoc": true,
+    //"github_update": true,
+    //"noncrawl_hosts": [],
+    //"github": {
+    //  "clientid": "",
+    //  "clientsecret": "",
+    //}
+  },
 
-	docdb: {
-		// nonstore_regexps: []
-	}
+  "docdb": {
+    //"nonstore_regexps": [],
+  },
 
-	bi: {
-		// data_path: "/tmp/gcse.bolt"
-		// web_path: "/bi"
-	}
+  "bi": {
+    //"data_path": "/tmp/gcse.bolt",
+    //"web_path": "/bi",
+  }
 }

scripts/install.gs

@@ -18,6 +18,16 @@ if *goGet {
 	Printfln("go get -u -v %s/%s", GCSE, a)
 	MustSucc(Bash("go get -u -v %s/%s", GCSE, a))
   }
+
+  additionalPackages := []string{
+    "github.com/golangplus/fmt",
+    "github.com/golangplus/container/heap",
+    "github.com/golangplus/testing/assert",
+  }
+  for _, pkg := range additionalPackages {
+    Printfln("go get -u -v %s", pkg)
+    MustSucc(Bash("go get -u -v %s", pkg))
+  }
 }
 
 Println("go test -a")
@@ -31,4 +41,3 @@ for _, a := range APPS {
   Printfln("go install -a %s/%s", GCSE, a)
   MustSucc(Bash("go install -a %s/%s", GCSE, a))
 }
-