Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Add instructions for git submodules #535

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ prepare:
rustup component add rustfmt
rustup component add clippy
rustup toolchain install nightly --allow-downgrade -c rustfmt clippy
git submodule update --init --recursive

check:
cargo +nightly fmt --all
Expand Down
36 changes: 29 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,36 @@ 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
```

## Contributing

Expand All @@ -39,8 +61,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.

Expand Down
Loading