robossembler/ros2nix
7
0
Fork 0
mirror of https://github.com/wentasah/ros2nix.git synced 2025-06-09 15:52:23 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Extend README

Browse source
This commit is contained in:
Michal Sojka 2024-09-21 20:18:05 +02:00
parent 11e7f90414
commit 3315d0cd36
1 changed files with 14 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -1,7 +1,11 @@
# ros2nix # ros2nix
Tool to convert [ROS][] `package.xml` to [Nix][] expressions Tool to convert [ROS][] `package.xml` to [Nix][] expressions
compatible with [nix-ros-overlay][]. compatible with [nix-ros-overlay][]. Under the hood, it uses
[rosdep][] to convert ROS package names to nixpkgs attributes so that
you don't have to be concerned with it.
[rosdep]: https://github.com/ros-infrastructure/rosdep
## Installation ## Installation
@ -9,10 +13,19 @@ compatible with [nix-ros-overlay][].
```sh ```sh
nix-env --install -f https://github.com/wentasah/ros2nix/archive/main.tar.gz nix-env --install -f https://github.com/wentasah/ros2nix/archive/main.tar.gz
``` ```
or try it out without installation:
```sh
nix-shell -p '(import (fetchTarball "https://github.com/wentasah/ros2nix/archive/main.tar.gz")).default'
```
- With Nix flakes experimental feature: - With Nix flakes experimental feature:
```sh ```sh
nix profile install github:wentasah/ros2nix nix profile install github:wentasah/ros2nix
``` ```
or try it out without installation:
```sh
nix shell github:wentasah/ros2nix
```
## Usage examples ## Usage examples