Skip to content

Commit

Permalink
update deps instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
imrn99 committed Jan 8, 2025
1 parent 5f80a39 commit 3709782
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 17 deletions.
20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,26 +13,24 @@ and many-core architectures.
The current objective is to profile and benchmark performance of our structure in the context of our
kernels' implementations, and start introducing concurrency into our code.


## Quickstart

You can add `honeycomb` as a dependency of your project by adding the following lines to its `Cargo.toml`:

```toml
# [dependencies]
honeycomb = { git = "https://github.com/LIHPC-Computational-Geometry/honeycomb", tag = "0.6.0"} # remove tag for master branch build
honeycomb = { git = "https://github.com/LIHPC-Computational-Geometry/honeycomb", tag = "0.7.0" } # remove tag for master branch build
```

Alternatively, you can add the sub-crates that are currently published on crates.io:

```toml
# [dependencies]
honeycomb-core = "0.6.0"
honeycomb-kernels = "0.6.0"
honeycomb-render = "0.6.0"
honeycomb-core = "0.7.0"
honeycomb-kernels = "0.7.0"
honeycomb-render = "0.7.0"
```


## Project content

### Rust
Expand All @@ -54,8 +52,8 @@ The repository also hosts these members:

### User guide

The [user guide][UG] provides an overview of everything available in the project as well as usage instructions. It can
be generated offline using **mdbook**. Note that generating the doc using a stable toolchain is possible, the features
The [user guide][UG] provides an overview of everything available in the project as well as usage instructions. It can
be generated offline using **mdbook**. Note that generating the doc using a stable toolchain is possible, the features
just won't be documented as clearly.

```shell
Expand All @@ -72,19 +70,17 @@ kill $(pidof mdbook)
kill $(ps -e | awk '/mdbook/ {print $1}')
```


## Contributing

Contributions are welcome and accepted as pull requests on [GitHub][GH]. Feel free to use issues to report bugs,
missing documentation or suggest improvements of the project.

Note that a most of the code possess documentation, including private modules / items / sections. You can generate
the complete documentation by using the instructions [above](#user-guide) and passing the option
the complete documentation by using the instructions [above](#user-guide) and passing the option
`--document-private-items` to `cargo doc`.

[GH]: https://github.com/LIHPC-Computational-Geometry/honeycomb


## License

Licensed under either of
Expand All @@ -98,7 +94,7 @@ at your preference.

The [SPDX](https://spdx.dev) license identifier for this project is `MIT OR Apache-2.0`.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as
defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.


Expand Down
12 changes: 7 additions & 5 deletions user-guide/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ The current objective is to
- ~implement basic meshing algorithms to evaluate the viability of the implementation & improve our structure using
Rust's framework to streamline the refactoring and parallelization process~
- ~Benchmark and/or profile and/or parallelize our first algorithm, **grisubal**~
- Ship a first stable version of the library (see this [issue](https://github.com/LIHPC-Computational-Geometry/honeycomb/issues/150))
- Ship a first stable version of the library (see
this [issue](https://github.com/LIHPC-Computational-Geometry/honeycomb/issues/150))
- Work on efficient parallelism

### Core Requirements
Expand All @@ -37,16 +38,16 @@ You can add `honeycomb` as a dependency of your project by adding the following

```toml
# [dependencies]
honeycomb = { git = "https://github.com/LIHPC-Computational-Geometry/honeycomb", tag = "0.6.0"} # remove tag for master branch build
honeycomb = { git = "https://github.com/LIHPC-Computational-Geometry/honeycomb", tag = "0.7.0" } # remove tag for master branch build
```

Alternatively, you can add the sub-crates that are currently published on crates.io:

```toml
# [dependencies]
honeycomb-core = "0.6.0"
honeycomb-kernels = "0.6.0"
honeycomb-render = "0.6.0"
honeycomb-core = "0.7.0"
honeycomb-kernels = "0.7.0"
honeycomb-render = "0.7.0"
```

Note that if you want to access the latest changes and documentation, you may have to specify a commit instead of a
Expand All @@ -59,6 +60,7 @@ You can generate this book and the Rust documentation locally using respectively
```shell
mdbook serve --open user-guide/
```

```shell
cargo +nightly doc --all --all-features --no-deps
```
Expand Down

0 comments on commit 3709782

Please sign in to comment.