diff --git a/README.md b/README.md index fe49e96..f7a1f98 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,20 @@ Sub packages are commands for running: * [MergeDocs](http://github.com/daviddengcn/gcse/mergedocs): Merge crawled package files with doc DB. * [Indexer](http://github.com/daviddengcn/gcse/indexer): Analyzing package information and generating indexed data for searching. +Development +----------- + +You'll need to perform the following steps to get a basic server running: + + 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. Visit [http://localhost:8080](http://localhost:8080) in your browser + + LICENSE ------- BSD license.