Skip to content

Commit

Permalink
Add documentation about git submodules for developers
Browse files Browse the repository at this point in the history
  • Loading branch information
filoozom committed Oct 31, 2018
1 parent 0308251 commit 98bf449
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Expand Up @@ -294,6 +294,20 @@ There are multiple ways you can find help in using LevelDB in Node.js:
See the [contribution guide](https://github.com/Level/community/blob/master/CONTRIBUTING.md) for more details.

### Git Submodules

This project uses Git Submodules. This means that you should clone it recursively if you're planning on working on it:

```bash
$ git clone --recurse-submodules https://github.com/Level/leveldown.git
```

Alternatively, you can initalize submodules inside the cloned folder:

```bash
$ git submodule update --init --recursive
```

### Windows

A large portion of the Windows support comes from code by [Krzysztof Kowalczyk](http://blog.kowalczyk.info/) [@kjk](https://twitter.com/kjk), see his Windows LevelDB port [here](http://code.google.com/r/kkowalczyk-leveldb/). If you're using `leveldown` on Windows, you should give him your thanks!
Expand Down

0 comments on commit 98bf449

Please sign in to comment.