Skip to content

docs: improve README with usage examples and configuration reference#16

Merged
duna-feline merged 1 commit intodevfrom
docs/improve-readme
Feb 16, 2026
Merged

docs: improve README with usage examples and configuration reference#16
duna-feline merged 1 commit intodevfrom
docs/improve-readme

Conversation

@duna-feline
Copy link
Copy Markdown
Collaborator

Added usage examples, configuration reference, installation instructions, and comparison with gllvm/wllvm.

…d comparison

- Add "How It Works" section with ASCII flow diagram
- Expand installation instructions (prerequisites, crates.io, from source)
- Add comprehensive usage examples (single file, bitcode extraction, build systems)
- Document wrapper CLI flags and rllvm-get-bc options (-b, -m, -o)
- Reorganize configuration reference with cleaner table
- Add "Why rllvm?" comparison with gllvm/wllvm
- Add crates.io badge
- Update example config paths to modern Homebrew prefix
@duna-feline duna-feline merged commit 6d65dae into dev Feb 16, 2026
6 checks passed
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