From 3315d0cd36de675d454e4c7e98d946038e92ff1f Mon Sep 17 00:00:00 2001 From: Michal Sojka Date: Sat, 21 Sep 2024 20:18:05 +0200 Subject: [PATCH] Extend README --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 23acb37..203ac5b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ # ros2nix 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 @@ -9,10 +13,19 @@ compatible with [nix-ros-overlay][]. ```sh 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: ```sh nix profile install github:wentasah/ros2nix ``` + or try it out without installation: + ```sh + nix shell github:wentasah/ros2nix + ``` ## Usage examples