Skip to content

Simplify README and reorganize project structure#12

Merged
urmzd merged 5 commits intomainfrom
docs/simplify-readme
Mar 29, 2026
Merged

Simplify README and reorganize project structure#12
urmzd merged 5 commits intomainfrom
docs/simplify-readme

Conversation

@urmzd
Copy link
Copy Markdown
Owner

@urmzd urmzd commented Mar 29, 2026

Summary

  • Simplify README to focus on install.sh and core usage, removing verbose architecture/logging docs
  • Rename lgp-cli to lgp and lgp to lgp-core for simpler cargo install
  • Move examples into the lgp crate directory and remove the CLI example command
  • Move detailed references to the rlgp-thesis repository

Test plan

  • Verify install.sh works with prebuilt binary
  • Verify cargo install --path crates/lgp-cli still works
  • Verify examples run with cargo run --example
  • Confirm CI workflows pass

urmzd added 5 commits March 29, 2026 01:38
Remove the 'example' CLI command as examples are now better served by running them directly with 'cargo run' from the lgp crate. This simplifies the CLI surface and leverages standard Cargo tooling.
Update README to document the new way to run examples using 'cargo run' directly from the lgp crate. Remove references to the removed 'lgp example' CLI command and its --list option.
Move CartPole and Iris classification examples from the top-level examples directory to crates/lgp/examples. This colocates examples with the crate they demonstrate, improving project organization and making dependencies clearer. Update run instructions in example documentation to specify the lgp crate package explicitly.
@urmzd urmzd merged commit 8ca4510 into main Mar 29, 2026
2 checks passed
@urmzd urmzd deleted the docs/simplify-readme branch March 29, 2026 06:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant