docs(readme): add pip installation instructions and refine license section
This commit is contained in:
21
README.md
21
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
|
## Usage
|
||||||
|
|
||||||
### CLI Commands
|
### CLI Commands
|
||||||
@@ -155,14 +164,4 @@ The project includes GitHub workflows for building and deploying the package:
|
|||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
This project is licensed under the MIT License.
|
This project is licensed under the [MIT License](LICENSE). See the LICENSE file for details.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 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.
|
|
Reference in New Issue
Block a user