Skip to content

refactor: update README for organization migration and cleanup formatting #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
masonlet merged 3 commits into from
Mar 11, 2026
Merged

refactor: update README for organization migration and cleanup formatting #11

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5992f0b
refactor: update URLs from personal profile to organization
masonlet Mar 11, 2026
56dd09f
style: remove <br/> from README
masonlet Mar 11, 2026
6359440
refactor: remove comments and clean up instructions
masonlet Mar 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 6 additions & 21 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Starlet Serializer

![Tests](https://github.com/masonlet/starlet-serializer/actions/workflows/test.yml/badge.svg)
![Tests](https://github.com/starlet-engine/serializer/actions/workflows/test.yml/badge.svg)
[![C++20](https://img.shields.io/badge/C%2B%2B-20-blue.svg)](https://isocpp.org/std/the-standard)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)

Expand All @@ -24,15 +24,12 @@ A lightweight serialization library for **Starlet** projects to handle both data
- Whitespace handling: `skipWhitespace`, `skipToNextLine`, `trimEOL`
- Error-safe macros: `STARLET_PARSE_OR`, `STARLET_PARSE_STRING_OR`

<br/>


## Prerequisites
- C++20 or later
- CMake 3.20+
- **Dependencies**:
- [starlet-math](https://github.com/masonlet/starlet-math) (auto-fetched)
- [starlet-logger](https://github.com/masonlet/starlet-logger) (auto-fetched)
- [starlet-math](https://github.com/starlet-engine/math) (auto-fetched)
- [starlet-logger](https://github.com/starlet-engine/logger) (auto-fetched)

## Installation

Expand All @@ -41,7 +38,7 @@ A lightweight serialization library for **Starlet** projects to handle both data
include(FetchContent)

FetchContent_Declare(starlet_serializer
GIT_REPOSITORY https://github.com/masonlet/starlet-serializer.git
GIT_REPOSITORY https://github.com/starlet-engine/serializer.git
GIT_TAG main
)
FetchContent_MakeAvailable(starlet_serializer)
Expand All @@ -51,30 +48,18 @@ target_link_libraries(app_name PRIVATE starlet_serializer)

### Building from Source
```bash
# Clone the repository
git clone https://github.com/masonlet/starlet-serializer.git
cd starlet-serializer

# Configure and build
git clone https://github.com/starlet-engine/serializer.git
cd serializer
cmake -B build
cmake --build build
```

<br/>


## Testing
```bash
# Configure with tests enabled
cmake -B build -DBUILD_TESTS=ON

# Build and run tests
cmake --build build
ctest --test-dir build --output-on-failure
```

<br/>


## License
MIT License - see [LICENSE](./LICENSE) for details.
Loading