More detailed setup documents with less assumptions on users

[rfan-debug]

• Provide a more detailed setup-documents.
• Hand-tested this document on a clean Ubuntu system without go, npm, nodejs.
• More instructions on running tests.

[salemhilal]

Hey, this is a really solid start. I left a few comments, but in general:

• I'd like to keep the quick start guide as brief as is reasonable.
• I think it makes sense to use the default-config.json as an example config instead of adding another config to the repo.

[salemhilal]

I think that the quick start guide for the most part should be kept relatively brief. The config-example.json documents the variety of ways to set up a repo in lieu of more explicit documentation. Since we don't really know what sort of repo people want to track, it's probably a good idea to not make a ton of assumptions.

Instead, it might be helpful to use the default-config.json that's included in the root of the repo:

Create a config.json file and use it to list your repositories. Check out our example config.json to see how to set up various types of repositories. For example, we can configure Hound to search its own source code using the config found in default-config.json:

{
  "dbpath" : "db",
  "repos" : {
    "Hound" : { "url" : "https://github.com/etsy/hound.git" }
  }
}

[rfan-debug]

I see. thank you! I did not notice there was a simplified default-config.json earlier

[salemhilal]

We could probably make this a bit terser:

0. Install Go if you don't have it already. Hound requires version 1.4 or later. You might also want to define a GOPATH environment variable) (it defaults to $HOME/go if you don't explicitly have one set). If everything is installed properly, go version will print out the installed version of go.

[rfan-debug]

Thanks for your suggestion. Updated.

[salemhilal]

I think I'd also omit the arguments to houndd, although I would mention that it needs to be run from the same directory that the config file is in.

[rfan-debug]

Sure. i can remove that.

[salemhilal]

To clean things up a bit:

4. By default, hound hosts a web ui at http://localhost:6080 . Open it in your browser, and start searching.

I don't necessarily think we need another screenshot of the UI here since we include that gif at the top of the README.

[rfan-debug]

Done. Removed.

[salemhilal]

Same comment here as above.

[rfan-debug]

Updated.

[salemhilal]

I mentioned this above, but I think default-config.json does the job of providing a simple config example. It also uses Hound's own source code on Github, so we know it'll work out of the box for most people. I believe it's used in our Dockerfile, so it might make sense to leave it (as well as the example config) in the root of the repository for now.

[rfan-debug]

I will remove this configuration file and use the original example config.

[salemhilal]

Three minor tweaks, but this looks good to me otherwise.

[salemhilal]

@rfan-debug I applied my suggestions to this branch. If you're ok with them, I'll squash and merge this branch into master.

[rfan-debug]

@salemhilal Please do! Thanks!

[rfan-debug]

@salemhilal i resolved the merge conflicts.