Skip to content

Commit

Permalink
docs(cxx): remove the rust info
Browse files Browse the repository at this point in the history
  • Loading branch information
pplmx committed Aug 21, 2024
1 parent 122e571 commit fab989b
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 8 deletions.
2 changes: 1 addition & 1 deletion template/cxx/{{cookiecutter.project_slug}}/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ If the required subsection does not exist yet under **Unreleased**, create it!

### Set up

This is no different from other Rust projects.
This is no different from other C++ projects.

```shell
git clone https://github.com/{{cookiecutter.__gh_slug}}
Expand Down
27 changes: 20 additions & 7 deletions template/cxx/{{cookiecutter.project_slug}}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,33 @@

## Installation

### Cargo

- Install the rust toolchain in order to have cargo installed by following
[this](https://www.rust-lang.org/tools/install) guide.
- run `cargo install {{cookiecutter.project_slug}}`
### Build

- Ensure you have a C++ compiler installed (e.g., `g++`, `clang++`).
- Install [CMake](https://cmake.org/install/) and any necessary dependencies.
- Clone the repository:
```sh
git clone https://github.com/{{cookiecutter.__gh_slug}}.git
```
- Create a build directory and run CMake:
```sh
mkdir build && cd build
cmake ..
make
```
- Run the executable:
```sh
./{{cookiecutter.project_slug}}
```

## License

Licensed under either of

- Apache License, Version 2.0
([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-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)
([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

Expand Down

0 comments on commit fab989b

Please sign in to comment.