Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tarc/ardutooling
https://github.com/tarc/ardutooling
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/tarc/ardutooling
- Owner: tarc
- Created: 2024-11-22T05:22:18.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-11-24T00:00:00.000Z (about 1 month ago)
- Last Synced: 2024-11-24T00:20:06.733Z (about 1 month ago)
- Language: Nix
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[![Donate!][donate github]][github sponsors link]
# Ardutooling
This repository provides all the required tooling for the [ArduPilot] project. It's structured as a collection of Nix expressions, similar to what is done in [`nixpkgs`]. It is based on the [`my-own-nixpkgs`] template.
[ardupilot]: https://ardupilot.org/
[`nixpkgs`]: https://github.com/NixOS/nixpkgs
[`my-own-nixpkgs`]: https://github.com/drupol/my-own-nixpkgs
## Usage
### Setting Up
1. Install [Nix]
2. Setup [Cachix], a binary cache
3. Setup [`direnv`], for automatic handling shell environments
4. Install the [`nix-direnv`] plugin
[Nix]: https://nixos.org/download/
[Cachix]: https://cachix.org/
[`direnv`]: https://direnv.net/
[`nix-direnv`]: https://github.com/nix-community/nix-direnv
### Setup a new development environment
Scaffold a project with the flake template.
### Integrating Your Repository as an Overlay
To use this repository as an overlay in another project, follow these steps:
1. **Add the Repository as an Input**:
Add the following to your `nix` file to include this repository as an input:
```nix
inputs = {
my-custom-nixpkgs.url = "repo-url"; # Replace "repo-url" with the actual URL to your repository
};
```
2. **Include the Overlay in `pkgs`**:
When constructing `pkgs`, include the overlay as follows:
```nix
pkgs = import inputs.nixpkgs {
overlays = [
inputs.my-custom-nixpkgs.overlays.default
];
};
```
3. **Use Your Packages**:
Access the packages in your project like this:
```nix
buildInputs = [ pkgs.example1 pkgs.example2 ];
```
[RFC140]: https://github.com/NixOS/rfcs/pull/140
### Examples
Refer to the dummy projects `example1` and `example2` for practical examples of
how packages can be structured.
## Going further
- Use the continuous integration service of your choice to build and test your
packages
- Add a binary cache to your repository to speed up builds and avoid
recompilation using [Cachix](https://cachix.org/)
- This project uses a flake framework, we recommend to use [flake-parts](https://flake.parts)
## Contributing
Feel free to contribute by sending pull requests. We are a usually very
responsive team and we will help you going through your pull request from the
beginning to the end.
For some reasons, if you can't contribute to the code and willing to help,
sponsoring is a good, sound and safe way to show us some gratitude for the hours
we invested in this package.
Sponsor me on [Github][github sponsors link] and/or any of [the
contributors][6].
[donate github]: https://img.shields.io/badge/Sponsor-Github-brightgreen.svg?style=flat-square
[github sponsors link]: https://github.com/sponsors/tarc
[6]: https://github.com/tarc/ardutooling/graphs/contributors