* [RFC] add hints to CLAUDE
@ 2025-07-08 19:09 Stephen Hemminger
0 siblings, 0 replies; only message in thread
From: Stephen Hemminger @ 2025-07-08 19:09 UTC (permalink / raw)
To: dev; +Cc: Stephen Hemminger
Soon users are going to want to use AI code generation like Claude
with DPDK. There is a convention for giving hints to AI tool.
Rough first draft
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
CLAUDE.md | 33 +++++++++++++++++++++++++++++++++
1 file changed, 33 insertions(+)
create mode 100644 CLAUDE.md
diff --git a/CLAUDE.md b/CLAUDE.md
new file mode 100644
index 0000000000..42dd2e2ade
--- /dev/null
+++ b/CLAUDE.md
@@ -0,0 +1,33 @@
+# Project: DPDK
+
+## Project Description
+DPDK is a set of libraries and drivers for fast packet processing.
+It supports many processor architectures and both Linux, FreeBSD and Windows.
+
+## Licensing
+Overall project use BSD-3-Clause license with some approved exceptions.
+
+## Build Commands
+This is a C library project that uses the meson build system:
+- Build: meson setup build && ninja -C build
+- Run tests: meson test -C build --suite fast-tests
+
+## Code Conventions
+- license is per file via SPDX-License-Identifier
+- use Tabs for indentation
+- closing and opening braces on same line as the keyword
+- braces that are not necessary should be left out
+- avoid using camelCase and PascalCase
+
+
+## Project Structure
+- /lib/ - libraries
+- /license - reference copy of licenses
+- /drivers - device drivers
+- /examples - sample applications
+- /doc - documentation
+- /devtools - developer tools
+- /usertools - user tools
+- /kernel/
+ - /linux/uapi - exported kernel headers
+ - /freebsd - drivers for FreeBSD
--
2.47.2
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2025-07-08 19:10 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2025-07-08 19:09 [RFC] add hints to CLAUDE Stephen Hemminger
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).