Skip to content

Commit

Permalink
readme: Split readme
Browse files Browse the repository at this point in the history
readme: summarize conda instruction
  • Loading branch information
jorisv committed Nov 6, 2024
1 parent f8faf38 commit 758303e
Show file tree
Hide file tree
Showing 5 changed files with 59 additions and 37 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
build*
build*/
Xcode*
*~
*.pyc
Expand Down
43 changes: 7 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,13 @@ The [master branch](https://github.com/stack-of-tasks/pinocchio/tree/master/) on

**Pinocchio** can be easily installed on various Linux (Ubuntu, Fedora, etc.) and Unix distributions (Mac OS X, BSD, etc.). Please refer to the [installation procedure](http://stack-of-tasks.github.io/pinocchio/download.html).

If you only need the Python bindings of Pinocchio, you may prefer to install it through [Conda](https://docs.conda.io/en/latest/). Please follow the procedure described [here](https://github.com/conda-forge/pinocchio-feedstock#installing-pinocchio).
### Conda

You simply need this simple line:

```bash
conda install pinocchio -c conda-forge
```

### ROS

Expand Down Expand Up @@ -190,41 +196,6 @@ Please note that we always advise including the `pinocchio/fwd.hpp` header as th
| | |      | **Humble** | [![](https://build.ros2.org/job/Hbin_uJ64__pinocchio__ubuntu_jammy_amd64__binary/badge/icon)](https://build.ros2.org/job/Hbin_uJ64__pinocchio__ubuntu_jammy_amd64__binary) |
| | |      | **Rolling** | [![](https://build.ros2.org/job/Rbin_uJ64__pinocchio__ubuntu_jammy_amd64__binary/badge/icon)](https://build.ros2.org/job/Rbin_uJ64__pinocchio__ubuntu_jammy_amd64__binary) |

## Build/install from source with Pixi

To build **Pinocchio** from source the easiest way is to use [Pixi](https://pixi.sh/latest/#installation).

[Pixi](https://pixi.sh/latest/) is a cross-platform package management tool for developers that
will install all required dependencies in `.pixi` directory.
It's used by our CI agent so you have the guarantee to get the right dependencies.

Run the following command to install dependencies, configure, build and test the project:

```bash
pixi run test
```

The project will be built in the `build` directory.
You can run `pixi shell` and build the project with `cmake` and `ninja` manually.

## Release with Pixi

To create a release with Pixi run the following commands on the **devel** branch:

```bash
PINOCCHIO_VERSION=X.Y.Z pixi run release_new_version
git push origin
git push origin vX.Y.Z
git push origin devel:master
```

Where `X.Y.Z` is the new version.
Be careful to follow the [Semantic Versioning](https://semver.org/spec/v2.0.0.html) rules.

You will find the following assets to upload to GitHub:
- `./build_new_version/pinocchio-X.Y.Z.tar.gz`
- `./build_new_version/pinocchio-X.Y.Z.tar.gz.sig`

## Visualization

**Pinocchio** provides support for many open-source and free visualizers:
Expand Down
17 changes: 17 additions & 0 deletions development/build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Build and install from source with Pixi

To build **Pinocchio** from source the easiest way is to use [Pixi](https://pixi.sh/latest/#installation).

[Pixi](https://pixi.sh/latest/) is a cross-platform package management tool for developers that
will install all required dependencies in `.pixi` directory.
It's used by our CI agent so you have the guarantee to get the right dependencies.

Run the following command to install dependencies, configure, build and test the project:

```bash
pixi run test
```

The project will be built in the `build` directory.
You can run `pixi shell` and build the project with `cmake` and `ninja` manually.

File renamed without changes.
34 changes: 34 additions & 0 deletions development/release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Release with Pixi

To create a release with Pixi run the following commands on the **devel** branch:

```bash
PINOCCHIO_VERSION=X.Y.Z pixi run release_new_version
git push origin
git push origin vX.Y.Z
git push origin devel:master
```

Where `X.Y.Z` is the new version.
Be careful to follow the [Semantic Versioning](https://semver.org/spec/v2.0.0.html) rules.

You will find the following assets:
- `./build_new_version/pinocchio-X.Y.Z.tar.gz`
- `./build_new_version/pinocchio-X.Y.Z.tar.gz.sig`

Then, create a new release on [GitHub](https://github.com/stack-of-tasks/pinocchio/releases/new) with:

* Tag: vX.Y.Z
* Title: pinocchio X.Y.Z
* Body:
```
## What's Changed
CHANGELOG CONTENT
**Full Changelog**: https://github.com/stack-of-tasks/pinocchio/compare/vXX.YY.ZZ...vX.Y.Z
```

Where `XX.YY.ZZ` is the last release version.

Then upload `pinocchio-X.Y.Z.tar.gz` and `pinocchio-X.Y.Z.tar.gz.sig` and publish the release.

0 comments on commit 758303e

Please sign in to comment.