README.md

Author: yezzfusl

README.md

@@ -1 +1,33 @@
-# CAN-Analyzer
+# Can-Analyzer
+
+**Can-Analyzer** is a sophisticated CAN bus analyzer developed in C. It provides real-time CAN data capture, filtering, decoding, and more. This tool is designed to help analyze and visualize CAN communication efficiently.
+
+## Features
+
+- [x] Basic CAN Communication
+- [x] CAN Message Filtering
+- [x] CAN Message Decoding
+- [ ] Real-time Data Display
+- [ ] Error Detection and Handling
+- [ ] Statistical Analysis Tools
+- [ ] Graphical Representation of Data
+
+## Getting Started
+
+### Prerequisites
+
+- Linux-based operating system
+- SocketCAN library (for CAN communication)
+- Required development tools (e.g., gcc)
+
+### Installation
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/yezzfusl/CAN-Analyzer.git```
+
+2. Navigate to the project directory:
+  ```cd CAN-Analyzer```
+3. Build the project using `Makefile`:
+  ```make```
+