Skip to content

Commit f74ae98

Browse files
committed
add ctags installation instructions to readme
1 parent e72fa8f commit f74ae98

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,12 +130,16 @@ Sourcebot also supports indexing GitLab & BitBucket. Checkout the [index.json](.
130130

131131
1. Install <a href="https://go.dev/doc/install"><img src="https://go.dev/favicon.ico" width="16" height="16"> go</a> and <a href="https://nodejs.org/"><img src="https://nodejs.org/favicon.ico" width="16" height="16"> NodeJS</a>. Note that a NodeJS version of at least `21.1.0` is required.
132132

133-
2. Clone the repository with submodules:
133+
2. Install ctags (required by zoekt-indexserver):
134+
Mac: `brew install universal-ctags`
135+
Ubuntu: `apt-get install universal-ctags`
136+
137+
3. Clone the repository with submodules:
134138
```sh
135139
git clone --recurse-submodules https://github.com/TaqlaAI/sourcebot.git
136140
```
137141

138-
3. Run make to build zoekt and install dependencies:
142+
4. Run make to build zoekt and install dependencies:
139143
```sh
140144
cd sourcebot
141145
make

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"scripts": {
66
"dev": "npm-run-all --print-label --parallel next:dev zoekt:webserver zoekt:indexserver",
77
"zoekt:webserver": "export PATH=\"$(PWD)/bin:$PATH\" && zoekt-webserver -index .sourcebot/index -rpc",
8-
"zoekt:indexserver": "export PATH=\"$(PWD)/bin:$PATH\" && zoekt-indexserver -data_dir .sourcebot -mirror_config config.json",
8+
"zoekt:indexserver": "export PATH=\"$(PWD)/bin:$PATH\" && export CTAGS_COMMAND=ctags && zoekt-indexserver -data_dir .sourcebot -mirror_config config.json",
99
"next:dev": "next dev",
1010
"build": "next build",
1111
"start": "next start",

0 commit comments

Comments
 (0)