From 3d52b6e13fd14ff1df61cb6e27d4f31445c82270 Mon Sep 17 00:00:00 2001 From: "Max P." Date: Fri, 18 Jul 2025 20:29:20 +0200 Subject: [PATCH] docs(readme): add pip installation instructions and refine license section --- README.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index a92e32a..34519a9 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,15 @@ HDLBuild is a flexible build management tool for FPGA projects. It simplifies th --- +## Installation per pip + +To install HDLBuild via pip, run: +```bash +pip install --index-url https://git.0xmax42.io/api/packages/maxp/pypi/simple/ --extra-index-url https://pypi.org/ hdlbuild +``` + +--- + ## Usage ### CLI Commands @@ -155,14 +164,4 @@ The project includes GitHub workflows for building and deploying the package: ## License -This project is licensed under the MIT License. - ---- - -## Contributing - -Contributions are welcome! Please follow these steps: - -1. Fork the repository. -2. Create a new branch for your feature or bugfix. -3. Submit a pull request. +This project is licensed under the [MIT License](LICENSE). See the LICENSE file for details. \ No newline at end of file