docs: simplify README for install.sh and core usage#11
Merged
Conversation
Strip verbose sections (architecture, output structure, hyperparameter details, full CLI reference) in favor of a concise install + usage flow. The prebuilt binary install via install.sh is now the recommended path.
Keep all original references with categorical grouping intact — important context for an academic project.
Consolidate all academic references in the thesis repo and point readers there from the README.
Add back the feature overview, supported environments, full CLI reference with flags, hyperparameter search details, output structure, log levels, and core traits — keeping the streamlined install.sh flow.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
install.sh(prebuilt binary) as the recommended install methodlgp --helpand SKILL.mdTest plan
install.shcurl command works