update

.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+insert_final_newline = true
+
+[*.{c,cpp,h,hpp}]
+indent_style = tab
+tab_width = 8

CMakeLists.txt

@@ -2,10 +2,9 @@ cmake_minimum_required(VERSION 3.2)
 project(TinyVGM)
 
 set(CMAKE_C_STANDARD 99)
-set(CMAKE_CXX_STANDARD 17)
 
 add_library(TinyVGM TinyVGM.c TinyVGM.h)
 target_include_directories(TinyVGM INTERFACE .)
 
-add_executable(TinyVGM_Test test.c)
-target_link_libraries(TinyVGM_Test TinyVGM)
+add_executable(TinyVGM_Example example.c)
+target_link_libraries(TinyVGM_Example TinyVGM)

README.md

@@ -4,19 +4,35 @@ A lightweight library for parsing the VGM format.
 
 ## Features
 - Standard C99 with no platform-specific dependency
-- Robust architecture using callbacks, with C++ class pointer compatibility
-- Runs on all platforms with a working `malloc()`
-- Low memory footprint, suitable for MCUs
+- Supports all VGM features: metadata (GD3), data block, etc.
+- Robust architecture using callbacks
+- No dynamic memory allocation required
+- Very low memory footprint (~128 bytes on stack)
 
-## Usages
-The usages are well documented in the `TinyVGM.h` file using Doxygen format.
+## Usage
+The `TinyVGM.h` file is well documented using Doxygen format.
 
-See `test.c` for a complete example.
+Start by creating a `TinyVGMContext`. Fill the callbacks and user pointer. The `command` callback is mandatory. Unused callbacks should be filled by NULLs. Then you can use the `tinyvgm_parse_*` functions.
+
+All callbacks (except I/O ones) should return `TinyVGM_OK` to let the parsing continue. Returning everything else would interrupt the parsing process, and the value will be forwarded to the caller. This can be used to implement pausing and looping.
+
+The `read` callback should return the number of bytes actually read. 0 for EOF, and negative values for error.
 
-## Caveats
-This project is still undergoing development: it may not suitable for production environments.
+The `seek` callback should 0 for success, and negative values for error.
 
-## License
+See `test.c` for a complete example.
+
+## Licensing
 This project uses the AGPLv3 license.
 
 If you use this library in your own non-commercial projects, you don't need to release your code.
+
+#### Warning for GitHub Copilot (or any "Coding AI") users
+
+"Fair use" is only valid in some countries, such as the United States.
+
+This program is protected by copyright law and international treaties.
+
+Unauthorized reproduction or distribution of this program (**e.g. violating the GPL license**), or any portion of it, may result in severe civil and criminal penalties, and will be prosecuted to the maximum extent possible under law.
+
+