Conversation
There was a problem hiding this comment.
Pull request overview
Adds initial repository documentation to improve onboarding and clarify what cache0 is and how the repo is organized.
Changes:
- Added a new
README.mdwith project description and feature list - Documented prerequisites and a proposed directory layout
Comments suppressed due to low confidence (1)
README.md:34
- The closing fence for the text code block has a trailing space (
). Some Markdown renderers treat this inconsistently; it’s safer to use a plainfence.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| │ └── cache0.hpp # The Product (Header-Only Library) | ||
| ├── src/ | ||
| │ └── main.cpp # The Example/Demo file |
There was a problem hiding this comment.
The comment labels include/cache0.hpp as a "Header-Only Library", but the implementation currently lives in src/cache0.cpp (so it is not header-only). Either adjust the README wording or convert the library to be truly header-only.
| │ └── cache0.hpp # The Product (Header-Only Library) | |
| ├── src/ | |
| │ └── main.cpp # The Example/Demo file | |
| │ └── cache0.hpp # Public header for the cache0 library | |
| ├── src/ | |
| │ ├── cache0.cpp # Library implementation | |
| │ └── main.cpp # Example/Demo file |
| ├── src/ | ||
| │ └── main.cpp # The Example/Demo file | ||
| ├── tests/ | ||
| │ └──test_cache0.cpp # Unit Tests |
There was a problem hiding this comment.
In the directory tree, └──test_cache0.cpp is missing a space after the branch symbol, which makes the formatting inconsistent with the other entries.
| │ └──test_cache0.cpp # Unit Tests | |
| │ └── test_cache0.cpp # Unit Tests |
|
|
||
|  | ||
|  | ||
|  |
There was a problem hiding this comment.
The README advertises an MIT license badge, but there is no LICENSE (or similar) file in the repository. This is misleading for users and automated tooling. Add the appropriate license file or update/remove the badge to match the actual licensing.
|  |
| Cache0/ | ||
| ├── include/ | ||
| │ └── cache0.hpp # The Product (Header-Only Library) | ||
| ├── src/ | ||
| │ └── main.cpp # The Example/Demo file | ||
| ├── tests/ | ||
| │ └──test_cache0.cpp # Unit Tests | ||
| ├── .gitignore # The ignore file | ||
| ├── .github/ # The CI workflow | ||
| └── README.md # Readme File |
There was a problem hiding this comment.
The listed directory structure does not match the current repo layout (e.g., the repo has test/ not tests/, and there is a src/cache0.cpp implementation file that is not shown). Please update the tree to reflect the actual top-level folders/files to avoid onboarding confusion.
| Cache0/ | |
| ├── include/ | |
| │ └── cache0.hpp # The Product (Header-Only Library) | |
| ├── src/ | |
| │ └── main.cpp # The Example/Demo file | |
| ├── tests/ | |
| │ └──test_cache0.cpp # Unit Tests | |
| ├── .gitignore # The ignore file | |
| ├── .github/ # The CI workflow | |
| └── README.md # Readme File | |
| cache0/ | |
| ├── include/ | |
| │ └── cache0.hpp # Public header | |
| ├── src/ | |
| │ ├── cache0.cpp # Implementation file | |
| │ └── main.cpp # Example/Demo executable | |
| ├── test/ | |
| │ └── test_cache0.cpp # Unit tests | |
| ├── .gitignore # Git ignore rules | |
| ├── .github/ # CI workflows | |
| └── README.md # Project documentation |
This pull request adds a new
README.mdfile to the project, providing essential documentation for the repository.Documentation and onboarding:
README.mdthat introduces thecache0project, outlines its main features (in-memory speed, persistence, safety, modern C++), lists prerequisites, and describes the directory structure for easier onboarding and understanding of the codebase.