mirror of
https://github.com/ivuorinen/homebrew-tap.git
synced 2026-02-18 09:51:22 +00:00
Ismo Vuorinen
6de65bca11
- Add formula parser with Ruby AST parsing - Add GitHub Actions CI/CD workflows - Add Jekyll-based documentation site - Add RuboCop and Dependabot configuration - Add example formula for demonstration
55 lines
1.2 KiB
Markdown
55 lines
1.2 KiB
Markdown
# ivuorinen/homebrew-tap
|
|
|
|
A Homebrew tap for ivuorinen's custom formulae with automated documentation.
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
# Add the tap
|
|
brew tap ivuorinen/homebrew-tap
|
|
|
|
# Install a formula
|
|
brew install <formula-name>
|
|
|
|
# List available formulae
|
|
brew search ivuorinen/homebrew-tap/
|
|
```
|
|
|
|
## Documentation
|
|
|
|
Visit [https://ivuorinen.github.io/homebrew-tap/](https://ivuorinen.github.io/homebrew-tap/) for complete documentation of all available formulae.
|
|
|
|
## Available Formulae
|
|
|
|
The documentation is automatically generated from the formula files and includes:
|
|
- Installation instructions
|
|
- Dependencies
|
|
- Version information
|
|
- Source links
|
|
|
|
## Contributing
|
|
|
|
1. Fork this repository
|
|
2. Create a new formula in the `Formula/` directory
|
|
3. Follow the [Homebrew Formula Cookbook](https://docs.brew.sh/Formula-Cookbook)
|
|
4. Submit a pull request
|
|
|
|
The CI will automatically validate your formula and update the documentation.
|
|
|
|
## Development
|
|
|
|
```bash
|
|
# Install dependencies
|
|
bundle install
|
|
|
|
# Parse formulae locally
|
|
ruby scripts/parse_formulas.rb
|
|
|
|
# Serve documentation locally
|
|
cd docs && bundle exec jekyll serve
|
|
```
|
|
|
|
## License
|
|
|
|
This tap is released under the MIT License. See LICENSE for details.
|