movefasta/nix-ros-overlay
1
0
Fork 0
mirror of https://github.com/lopsided98/nix-ros-overlay.git synced 2025-06-10 01:42:24 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

README: Add example of using the overlay in flake.nix

Browse source
This commit is contained in:
Michal Sojka 2024-02-24 20:15:09 +01:00 • committed by Ben Wolsieffer
parent 5f5fc56984
commit b7be7029bf
1 changed files with 34 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -29,12 +29,46 @@ roslaunch turtlebot3_gazebo turtlebot3_world.launch
roslaunch turtlebot3_teleop turtlebot3_teleop_key.launch
```
### Flakes
With [Flakes enabled][flake], the equivalent of the above is:
```
nix develop github:lopsided98/nix-ros-overlay#example-turtlebot3-gazebo
# Then use roslaunch commands as above
```
Using the overlay in your `flake.nix`-based project could look like this:
```nix
{
inputs = {
nix-ros-overlay.url = "github:lopsided98/nix-ros-overlay";
nixpkgs.follows = "nix-ros-overlay/nixpkgs"; # IMPORTANT!!!
};
outputs = { self, nix-ros-overlay, nixpkgs }:
nix-ros-overlay.inputs.flake-utils.lib.eachDefaultSystem (system:
let
pkgs = import nixpkgs {
inherit system;
overlays = [ nix-ros-overlay.overlays.default ];
};
in {
devShells.default = pkgs.mkShell {
name = "Example project";
packages = with pkgs.rosPackages.humble; [
pkgs.colcon
ros-core
# ...
];
};
});
nixConfig = {
extra-substituters = [ "https://ros.cachix.org" ];
extra-trusted-public-keys = [ "ros.cachix.org-1:dSyZxI8geDCJrwgvCOHDoAfOm5sV1wCPjBkKL+38Rvo=" ];
};
}
```
[flake]: https://nixos.wiki/wiki/Flakes#Enable_flakes
## Current status