diff --git a/README.md b/README.md index 9e5e488..eeaf60b 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ # cad-libraries -In this repository we store the CAD libraries and the PTC Creo configuration files. -You have to use it to work with all iCub-tech CAD project. +In this repository, we store the CAD libraries and the PTC Creo configuration files. +You have to use it to work with all iCub-tech CAD projects. Please read the following rules before using the repository. ## Rules -- Changes for ` non-binary` files in this repository must be requested through [pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) from **personal** [forks](https://docs.github.com/en/get-started/quickstart/fork-a-repo). -- In order to modify the libraries it's mandatory to open a dedicated [issue request](https://github.com/icub-tech-iit/cad-libraries/issues/new/choose). Here a list of all requests that can be opened: +- Changes for `non-binary` files in this repository must be requested through [pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) from **personal** [forks](https://docs.github.com/en/get-started/quickstart/fork-a-repo). +- To modify the libraries it's mandatory to open a dedicated [issue request](https://github.com/icub-tech-iit/cad-libraries/issues/new/choose). Here is a list of all requests that can be opened: - **Edit library component**: open this issue to modify one library component. - - **New commercial ECAD component**: open this issue to create a new library item of an electrical component. + - **New commercial ECAD component**: Open this issue to create a new library item for an electrical component. - **New generic CAD component**: open this issue to create a new generic library item (i.e. not electrical). -- All CAD parts must be saved with `COMMERCIAL` license. +- All CAD parts must be saved with a `COMMERCIAL` license. - It's forbidden to commit parts subject to copyright or MBO. ## 👨🏻‍💻 Maintainers