Skip to content

Commit

Permalink
Remove submodule mentions from docs
Browse files Browse the repository at this point in the history
  • Loading branch information
yawaramin committed Dec 24, 2024
1 parent 27ff431 commit eadcbeb
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 21 deletions.
11 changes: 2 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -230,13 +230,6 @@ Highlight `@antron` to poke @aantron specifically.
All kinds of contributions are welcome, including examples, links to blogs,
related libraries, and, of course, PRs! See [CONTRIBUTING.md][contributing.md].

As an immediate note, if you'd like to clone the repo, be sure to use
`--recursive`, because Dream uses several git [submodules][vendor]:

```
git clone https://github.com/aantron/dream.git --recursive
```

[contributing.md]: https://github.com/aantron/dream/blob/master/docs/CONTRIBUTING.md

<br>
Expand All @@ -251,10 +244,10 @@ several influences that cannot be discovered directly:
and [**Embedded OCaml Templates**][eot] from [Emile Trotignon][trotignon].
- Dream's handler and middleware types are simplified from [**Opium**][opium] by
[Rudi Grinberg][rgrinberg] and contributors.
- The lower-level HTTP and WebSocket servers are [vendored][vendor] copies of
- The lower-level HTTP and WebSocket servers use
[Antonio Nuno Monteiro][anmonteiro]'s forks and original works, with credit
also due to their contributors, and [Spiros Eliopoulos][seliopou] in
particular, as the original author of two of the projects.
particular, as the original author of the http/af family of projects.
- The API docs are instantiated by [**Soupault**][soupault] from
[Daniil Baturin][dmbaturin].
- The name was inspired by [**Morph**][morph] from [Ulrik Strid][ulrikstrid],
Expand Down
13 changes: 1 addition & 12 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,10 @@ npx esy ls-builds
If you'd like to contribute code, clone the repository with

```
git clone https://github.com/aantron/dream.git --recursive
git clone https://github.com/aantron/dream.git
cd dream
```

Note: the clone *must* be `--recursive`, because Dream several dependencies
vendored as
[submodules](https://github.com/aantron/dream/tree/master/src/vendor).

Later, you'll need to fork the repository on GitHub, and add your fork as a
remote:

Expand Down Expand Up @@ -101,13 +97,6 @@ git push -u fork my-branch

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

If you want to work again later, be sure to use `--recurse-submodules` during
`git pull`, similar to `git clone --recursive`:

```
git pull --recurse-submodules
```

**Note:** Please don't force-push into a PR &mdash; it makes incremental review
very difficult, and we will squash-merge most PRs anyway!

Expand Down

0 comments on commit eadcbeb

Please sign in to comment.