Skip to content

Commit af3c9bf

Browse files
authored
Docs: we don't use submodules anymore (#372)
1 parent 087fb90 commit af3c9bf

File tree

2 files changed

+3
-21
lines changed

2 files changed

+3
-21
lines changed

README.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -232,13 +232,6 @@ Highlight `@antron` to poke @aantron specifically.
232232
All kinds of contributions are welcome, including examples, links to blogs,
233233
related libraries, and, of course, PRs! See [CONTRIBUTING.md][contributing.md].
234234

235-
As an immediate note, if you'd like to clone the repo, be sure to use
236-
`--recursive`, because Dream uses several git [submodules][vendor]:
237-
238-
```
239-
git clone https://github.com/aantron/dream.git --recursive
240-
```
241-
242235
[contributing.md]: https://github.com/aantron/dream/blob/master/docs/CONTRIBUTING.md
243236

244237
<br>
@@ -253,10 +246,10 @@ several influences that cannot be discovered directly:
253246
and [**Embedded OCaml Templates**][eot] from [Emile Trotignon][trotignon].
254247
- Dream's handler and middleware types are simplified from [**Opium**][opium] by
255248
[Rudi Grinberg][rgrinberg] and contributors.
256-
- The lower-level HTTP and WebSocket servers are [vendored][vendor] copies of
249+
- The lower-level HTTP and WebSocket servers use
257250
[Antonio Nuno Monteiro][anmonteiro]'s forks and original works, with credit
258251
also due to their contributors, and [Spiros Eliopoulos][seliopou] in
259-
particular, as the original author of two of the projects.
252+
particular, as the original author of the http/af family of projects.
260253
- The API docs are instantiated by [**Soupault**][soupault] from
261254
[Daniil Baturin][dmbaturin].
262255
- The name was inspired by [**Morph**][morph] from [Ulrik Strid][ulrikstrid],

docs/CONTRIBUTING.md

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,10 @@ npx esy ls-builds
3535
If you'd like to contribute code, clone the repository with
3636

3737
```
38-
git clone https://github.com/aantron/dream.git --recursive
38+
git clone https://github.com/aantron/dream.git
3939
cd dream
4040
```
4141

42-
Note: the clone *must* be `--recursive`, because Dream several dependencies
43-
vendored as
44-
[submodules](https://github.com/aantron/dream/tree/master/src/vendor).
45-
4642
Later, you'll need to fork the repository on GitHub, and add your fork as a
4743
remote:
4844

@@ -101,13 +97,6 @@ git push -u fork my-branch
10197

10298
GitHub should print a URL into your terminal for opening a pull request.
10399

104-
If you want to work again later, be sure to use `--recurse-submodules` during
105-
`git pull`, similar to `git clone --recursive`:
106-
107-
```
108-
git pull --recurse-submodules
109-
```
110-
111100
**Note:** Please don't force-push into a PR &mdash; it makes incremental review
112101
very difficult, and we will squash-merge most PRs anyway!
113102

0 commit comments

Comments
 (0)