From 1fc1c41737de142b38b713f25515c4e63aa422dc Mon Sep 17 00:00:00 2001 From: Daniel Xu Date: Thu, 4 Apr 2024 08:17:59 -0600 Subject: [PATCH] Add README Establish the motivation and purpose of this repository. --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..8c5be3a --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# user-tools + +This repository contains community contributed tools. This is different from +[official bpftrace tools][0] in that we do not intend to be as strict about +requirements. + +Thus, we encourage users to contribute anything they find useful for the +community. Motivations could include (but are not limited to): + +* Sharing useful functionality +* Sharing novel techniques +* Incubating a new official tool + +One intention is that all new official tools begin life in this repository. And +over time we'll develop some criteria for promoting a user tool to an official +tool that bpftrace maintainers will help support over long periods of time. + + +[0]: https://github.com/bpftrace/bpftrace/blob/master/CONTRIBUTING-TOOLS.md