-
Notifications
You must be signed in to change notification settings - Fork 116
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: Add instructions to gitclone with submodules
- Loading branch information
1 parent
8672af1
commit 463ca96
Showing
1 changed file
with
37 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,14 +16,44 @@ It's currently under active development and may not be ready for production use | |
|
||
You may be interested in: | ||
|
||
- [Examples and Usage](https://paperclip-rs.github.io/paperclip). | ||
- [Features being worked on](https://github.com/paperclip-rs/paperclip/projects). | ||
- [API documentation](https://paperclip-rs.github.io/paperclip/paperclip). | ||
- [Examples and Usage](https://paperclip-rs.github.io/paperclip). | ||
- [Features being worked on](https://github.com/paperclip-rs/paperclip/projects). | ||
- [API documentation](https://paperclip-rs.github.io/paperclip/paperclip). | ||
|
||
## Developing locally | ||
|
||
- Make sure you have [`rustup`](https://rustup.rs/) installed. `cd` into this repository and run `make prepare` to setup your environment. | ||
- Now run `make` to build and run the tests. | ||
- Clone the repository along with its submodules using the following command: | ||
|
||
```bash | ||
git clone --recurse-submodules [email protected]:paperclip-rs/paperclip.git | ||
``` | ||
|
||
- Make sure you have [`rustup`](https://rustup.rs/) installed. | ||
- Then move to repository: | ||
|
||
```bash | ||
cd paperclip | ||
``` | ||
|
||
- Run the setup environment routine | ||
|
||
```bash | ||
make prepare | ||
``` | ||
|
||
- Build the project and run tests: | ||
|
||
```bash | ||
make | ||
``` | ||
|
||
### Additional notes: | ||
|
||
- If you've already cloned the repository without `--recurse-submodules`, you can fetch submodules with: | ||
|
||
```bash | ||
git submodule update --init --recursive | ||
``` | ||
|
||
## Contributing | ||
|
||
|
@@ -39,8 +69,8 @@ This project follows the [Rust Code of Conduct](https://www.rust-lang.org/polici | |
|
||
Licensed under either of | ||
|
||
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) | ||
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) | ||
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>) | ||
- MIT license ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>) | ||
|
||
at your option. | ||
|
||
|