Skip to content

Commit 2753b2f

Browse files
committed
πŸ“ docs(changelog): Create changelog file
1 parent c2a33f1 commit 2753b2f

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

β€ŽCHANGELOG.mdβ€Ž

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# πŸ“œ CPPSerial Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
This format follows the principles of [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
5+
and adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
---
8+
9+
## [v1.0.0] β€” 2025-10-21
10+
### πŸŽ‰ First Stable Release
11+
12+
#### 🧩 Added
13+
- Modern **C++17 interface** for serial communication on Linux
14+
- Support for **custom baud rates**, including non-standard values
15+
- Configuration of **data bits, parity, and stop bits**
16+
- Exception-based **error handling** for improved safety
17+
- Clean **header-only design** for easy inclusion in embedded systems
18+
- **Doxygen documentation** and a concise usage example in `README.md`
19+
20+
#### πŸ› Fixed
21+
- Removed redundant and unsafe `termios` usage
22+
- Fixed initialization issues under certain device configurations
23+
- Improved internal validation and descriptive error messages
24+
25+
#### βš™οΈ Improved
26+
- Refactored low-level communication layer for better performance
27+
- Enhanced naming conventions and code consistency
28+
- Improved readability and adherence to C++ best practices
29+
30+
#### 🧾 Documentation
31+
- Added comments and Doxygen-style headers to all public classes
32+
- Provided getting started guide and API overview
33+
34+
#### 🧩 Compatibility
35+
- βœ… **Linux only**
36+
- 🧰 Tested on **Ubuntu 24.04**
37+
- 🧱 Compilers: GCC 11+, Clang 14+
38+
39+
#### βš–οΈ License
40+
- Distributed under **GNU General Public License v3.0 (GPLv3)**
41+
See [LICENSE](./LICENSE) for details.
42+
43+
---
44+
45+
## πŸͺ„ Template for Future Releases
46+
47+
Use this section as a guide for documenting future versions:
48+
49+
```markdown
50+
## [vX.Y.Z] β€” YYYY-MM-DD
51+
### πŸš€ Added
52+
- New feature X
53+
- Extended support for Y
54+
55+
### πŸ› Fixed
56+
- Fixed issue with Z
57+
58+
### βš™οΈ Improved
59+
- Performance optimizations in serial read/write
60+
- Simplified configuration handling
61+
62+
### 🧾 Documentation
63+
- Updated usage examples and API docs

0 commit comments

Comments
Β (0)