From efc57d658d93c421e9b590842f64b57a019a5fc8 Mon Sep 17 00:00:00 2001
From: deeaitch <himrodim@gmail.com>
Date: Fri, 13 Mar 2026 13:03:29 -0400
Subject: [PATCH] readme

---
 .gitignore |  1 +
 README.md  | 35 +++++++++++++++++++++++++++++++++--
 2 files changed, 34 insertions(+), 2 deletions(-)
 create mode 100644 .gitignore

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..8a9d35c
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+*.user
diff --git a/README.md b/README.md
index 272b83d..c416f87 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,34 @@
-# dbc
+# dbc parser skeleton
 
-some experiments with parsing dbc files
\ No newline at end of file
+A minimal DBC parser skeleton for the **FrameTap** project.
+
+The purpose of this module is to read a DBC file and convert it into a simple internal representation that can later be:
+
+- displayed as a tree
+- connected to `Qt Model/View`
+- used for signal selection
+- extended toward runtime CAN frame decoding
+
+---
+
+## Overview
+
+The architecture is intentionally simple:
+
+1. `dbc_parser` reads a DBC file
+2. parsed data is stored in `DbcDatabase`
+3. `dbc_tree_builder` converts it into a `TreeNode` hierarchy
+4. the resulting tree can later be adapted to `QAbstractItemModel`
+
+This keeps the parser independent from Qt and makes it easier to test and evolve.
+
+---
+
+## Currently supported
+
+### Frame definitions
+
+Supported frame lines:
+
+```text
+BO_ 256 EngineData: 8 EEC1
\ No newline at end of file