From 97282eb440ab42eac103f17ac91d3d5834cc0a8c Mon Sep 17 00:00:00 2001 From: Chunchun <14298407+appletreeisyellow@users.noreply.github.com> Date: Thu, 12 Jan 2023 14:32:34 -0600 Subject: [PATCH 1/4] chore: add another option to install hound --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 182e0658..407cbb3e 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,18 @@ print out the installed version of go. go get github.com/hound-search/hound/cmds/... ``` +If the above doesn't work for you, try to install hound manually with the following: + +``` +git clone https://github.com/hound-search/hound.git +cd hound +go build ./cmds/hound +go build ./cmds/houndd +sudo mv hound houndd ~/go/bin/ +``` + +You might have to change the path of the last command if you installed Go somewhere else on your system. + 2. Create a config.json file and use it to list your repositories. Check out our [example-config.json](config-example.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](default-config.json): From c6e30cfc941c20d2e909055dce234b427bc0605e Mon Sep 17 00:00:00 2001 From: Chunchun <14298407+appletreeisyellow@users.noreply.github.com> Date: Thu, 12 Jan 2023 14:33:43 -0600 Subject: [PATCH 2/4] chore: format --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 407cbb3e..ab614d41 100644 --- a/README.md +++ b/README.md @@ -22,21 +22,21 @@ print out the installed version of go. 1. Use the Go tools to install Hound. The binaries `houndd` (server) and `hound` (cli) will be installed in your $GOPATH/bin directory. Your $GOPATH should be in your $PATH (`echo $PATH` to check). -``` -go get github.com/hound-search/hound/cmds/... -``` + ``` + go get github.com/hound-search/hound/cmds/... + ``` -If the above doesn't work for you, try to install hound manually with the following: + If the above doesn't work for you, try to install hound manually with the following: -``` -git clone https://github.com/hound-search/hound.git -cd hound -go build ./cmds/hound -go build ./cmds/houndd -sudo mv hound houndd ~/go/bin/ -``` + ``` + git clone https://github.com/hound-search/hound.git + cd hound + go build ./cmds/hound + go build ./cmds/houndd + sudo mv hound houndd ~/go/bin/ + ``` -You might have to change the path of the last command if you installed Go somewhere else on your system. + You might have to change the path of the last command if you installed Go somewhere else on your system. 2. Create a config.json file and use it to list your repositories. Check out our [example-config.json](config-example.json) to see how to set up various types of repositories. For example, we can configure Hound to search its own source code using From 45ed6b105cba58d807ffe6afc3f5171b59f3af97 Mon Sep 17 00:00:00 2001 From: Chunchun <14298407+appletreeisyellow@users.noreply.github.com> Date: Thu, 12 Jan 2023 14:38:12 -0600 Subject: [PATCH 3/4] chore: add $GOPATH/bin in installation --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ab614d41..99b29070 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ print out the installed version of go. You might have to change the path of the last command if you installed Go somewhere else on your system. -2. Create a config.json file and use it to list your repositories. Check out our [example-config.json](config-example.json) +2. Create a config.json file in your `$GOPATH/bin` and use it to list your repositories. Check out our [example-config.json](config-example.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](default-config.json): @@ -52,8 +52,9 @@ the config found in [default-config.json](default-config.json): ``` -A complete list of available config options can be found [here](docs/config-options.md). -3. Run the Hound server with `houndd` in the same directory as your `config.json`. You should see output similar to: +A complete list of available config options can be found [here](docs/config-options.md). + +3. Run the Hound server with `houndd` in the same directory as your `config.json`, which is most likely your `$GOPATH/bin` directory. You should see output similar to: ``` 2015/03/13 09:07:42 Searcher started for statsd 2015/03/13 09:07:42 Searcher started for Hound From 5633e366fcfb04462b8b918801e4356df1bf02b4 Mon Sep 17 00:00:00 2001 From: dschott Date: Fri, 10 Feb 2023 11:24:45 -0800 Subject: [PATCH 4/4] fix indentation for bulleted list --- README.md | 30 ++++++++++++++---------------- 1 file changed, 14 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 99b29070..65bea998 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,6 @@ print out the installed version of go. 1. Use the Go tools to install Hound. The binaries `houndd` (server) and `hound` (cli) will be installed in your $GOPATH/bin directory. Your $GOPATH should be in your $PATH (`echo $PATH` to check). - ``` go get github.com/hound-search/hound/cmds/... ``` @@ -42,25 +41,24 @@ print out the installed version of go. 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](default-config.json): -```json -{ - "dbpath" : "db", - "repos" : { - "Hound" : { "url" : "https://github.com/etsy/hound.git" } + ```json + { + "dbpath" : "db", + "repos" : { + "Hound" : { "url" : "https://github.com/etsy/hound.git" } + } } -} -``` - + ``` -A complete list of available config options can be found [here](docs/config-options.md). + A complete list of available config options can be found [here](docs/config-options.md). 3. Run the Hound server with `houndd` in the same directory as your `config.json`, which is most likely your `$GOPATH/bin` directory. You should see output similar to: -``` -2015/03/13 09:07:42 Searcher started for statsd -2015/03/13 09:07:42 Searcher started for Hound -2015/03/13 09:07:42 All indexes built! -2015/03/13 09:07:42 running server at http://localhost:6080 -``` + ``` + 2015/03/13 09:07:42 Searcher started for statsd + 2015/03/13 09:07:42 Searcher started for Hound + 2015/03/13 09:07:42 All indexes built! + 2015/03/13 09:07:42 running server at http://localhost:6080 + ``` 4. By default, hound hosts a web ui at http://localhost:6080 . Open it in your browser, and start searching.