Skip to content

Commit 5280880

Browse files
committed
fix(docs): Improve setup docs
closes INT-149
1 parent b49800d commit 5280880

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,13 @@
22

33
Explore your MongoDB.
44

5-
<dl>
6-
<dt><a href="#{url}">#{title}</a></dt>
7-
<dd>#{description}</dd>
8-
</dl>
5+
## Developing
6+
7+
1. Follow the setup instructions for [OSX][setup-osx], [Windows][setup-windows] or [Linux][setup-linux].
8+
2. Clone this repo
9+
3. Run `npm install` to install dependencies
10+
4. Run `npm start` to launch
11+
12+
[setup-osx]: https://github.com/mongodb-js/mongodb-js/blob/master/docs/setup.md#osx-setup
13+
[setup-windows]: https://github.com/mongodb-js/mongodb-js/blob/master/docs/setup.md#windows-setup
14+
[setup-linux]: https://github.com/mongodb-js/mongodb-js/blob/master/docs/setup.md#linux-setup

0 commit comments

Comments
 (0)