From 7c533ed5f6d13f4528f7c3f1b95d6397753874a2 Mon Sep 17 00:00:00 2001 From: Robert Hensing Date: Mon, 13 May 2019 10:28:13 +0200 Subject: [PATCH] README: Add comparison --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 27fc63b..0e34d5e 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,31 @@ mkDerivation { - Also works with restrict-eval enabled (if avoiding `fetchFromGitHub`) - No import from derivation ("IFD") +## Comparison + +| Feature \ Implementation | cleanSource | [siers](https://github.com/siers/nix-gitignore) | [siers recursive](https://github.com/siers/nix-gitignore) | [icetan](https://github.com/icetan/nix-git-ignore-source) | [Profpatsch](https://github.com/Profpatsch/nixperiments/blob/master/filterSourceGitignore.nix) | [numtide](https://github.com/numtide/nix-gitignore) | this project +|-|-|-|-|-|-|-|-| +|Ignores .git | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ +|No special Nix configuration | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | ✔️ +|No import from derivation | ✔️ | ✔️ | | ✔️ | ✔️ | ✔️ | ✔️ +|Uses subdirectory gitignores | | | ✔️ | | | ✔️ | ✔️ +|Uses parent gitignores | | | | | |✔️ ?| ✔️ +|Uses user gitignores | | | | | | ✔️ | ✔️ +|Works with `restrict-eval` / Hydra | ✔️ | ✔️ | | ✔️ | ✔️ | | ✔️ +|Included in nixpkgs | ✔️ | ✔️ | ✔️ | | | | + + +| | Legend | +|---|-------------------------------------| +|✔️ | Supported +|✔️ ?| Probably supported +| | Probably not supported +|? | Probably not supported +|- | Not applicable or depends + + +Please open a PR if you've found another feature, determined any of the '?' or found an inaccuracy! + # Contributing This project isn't perfect (yet) so please submit test cases and fixes as pull requests. Before doing anything drastic, it's a good idea to open an issue first to discuss and optimize the approach.