PIVector2D - add funcs, optimize, tests, fixes, doxygen #194
32
AGENTS.md
32
AGENTS.md
@@ -18,36 +18,36 @@ PIP is a C++ cross-platform library providing platform-independent abstractions
|
||||
|
||||
### Basic Build
|
||||
```bash
|
||||
cmake -B ../build_pip
|
||||
cmake --build ../build_pip
|
||||
cmake -B build
|
||||
cmake --build build
|
||||
```
|
||||
|
||||
### Build with Tests
|
||||
```bash
|
||||
cmake -B ../build_pip -DTESTS=ON
|
||||
cmake --build ../build_pip
|
||||
cmake -B build -DTESTS=ON
|
||||
cmake --build build
|
||||
```
|
||||
|
||||
### Run Tests
|
||||
```bash
|
||||
ctest --test-dir ../build_pip/tests/ # Run all tests
|
||||
ctest --test-dir ../build_pip/tests/ -R <regex> # Run specific tests matching regex
|
||||
ctest --test-dir ../build_pip/tests/ -V # Verbose output
|
||||
ctest --test-dir build/tests # Run all tests
|
||||
ctest --test-dir build/tests -R <regex> # Run specific tests matching regex
|
||||
ctest --test-dir build/tests -V # Verbose output
|
||||
```
|
||||
|
||||
To run a single test:
|
||||
```bash
|
||||
# Build the test executable, then run directly:
|
||||
../build_pip/tests/pip_<test_name>_test
|
||||
./build/tests/pip_<test_name>_test
|
||||
# Or use ctest with specific test name
|
||||
ctest --test-dir ../build_pip/tests/ -R "TestName"
|
||||
ctest --test-dir build/tests -R "TestName"
|
||||
```
|
||||
|
||||
### Other Commands
|
||||
```bash
|
||||
cmake --build ../build_pip --target clean # Clean build
|
||||
cmake --install ../build_pip # Install
|
||||
cmake --build ../build_pip --target doc # Build documentation
|
||||
cmake --build build --target clean # Clean build
|
||||
cmake --install build_pip # Install
|
||||
cmake --build build --target doc # Build documentation
|
||||
```
|
||||
|
||||
### Build Options
|
||||
@@ -157,14 +157,6 @@ TEST(PIString_Tests, constructor_empty) {
|
||||
- Third-party: `3rd/`
|
||||
- Utils: `utils/`
|
||||
|
||||
### Important Macros
|
||||
- `PIP_EXPORT` - Export symbol from shared library
|
||||
- `PIP_NO_EXPORT` - Don't export
|
||||
- `PIP_DEPRECATED` - Mark as deprecated
|
||||
- Conditional compilation: `#ifdef PIP_ICU`, `#ifdef WINDOWS`, etc.
|
||||
|
||||
### Key Files
|
||||
- `CMakeLists.txt` - Main build configuration
|
||||
- `libs/main/pip.h` - Master include
|
||||
- `libs/main/piplatform.h` - Platform definitions
|
||||
- `tests/CMakeLists.txt` - Test configuration
|
||||
|
||||
Reference in New Issue
Block a user