colin/phone-case-cq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

readme: normalize punctuation

Browse Source
This commit is contained in:
Colin
2024-02-08 02:02:17 +00:00
parent c5b282646d
commit 94bf928388
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -22,7 +22,7 @@ you'll need a browser which supports webGL (e.g. chromium).
## Prerequisites ## Prerequisites
- run `nix develop` to enter a dev environment. - run `nix develop` to enter a dev environment
- or manually install these dependencies: - or manually install these dependencies:
- Python3 - Python3
- cadquery - cadquery
@@ -34,13 +34,13 @@ you'll need a browser which supports webGL (e.g. chromium).
- the models can be parameterized with environment variables: - the models can be parameterized with environment variables:
- `CASE_RENDER_PHONE=1` => render not just the case, but also what it would look like with the phone inside - `CASE_RENDER_PHONE=1` => render not just the case, but also what it would look like with the phone inside
- `CASE_RENDER_PHONE_ONLY=1` => render ONLY the phone, no case - `CASE_RENDER_PHONE_ONLY=1` => render ONLY the phone, no case
- `CASE_BATTERY=<name>` => design the case to fit a specific battery model, or "none". - `CASE_BATTERY=<name>` => design the case to fit a specific battery model, or "none"
## Development ## Development
- `./main.py --editor` or `cq-editor ./main.py` to load an interactive GUI - `./main.py --editor` or `cq-editor ./main.py` to load an interactive GUI
- press the green play button to render the model - press the green play button to render the model
- call with `--render-phone` to see how the phone would fit inside the case, or apply any of the environment variables from above. - call with `--render-phone` to see how the phone would fit inside the case, or apply any of the environment variables from above
- CadQuery docs may be found here: <https://cadquery.readthedocs.io/en/latest/quickstart.html> - CadQuery docs may be found here: <https://cadquery.readthedocs.io/en/latest/quickstart.html>
@@ -49,4 +49,4 @@ you'll need a browser which supports webGL (e.g. chromium).
- print using a flexible material like TPU - print using a flexible material like TPU
- the "ldtek" battery is sold under a few brands: - the "ldtek" battery is sold under a few brands:
- [Auskang](https://www.amazon.com/Auskang-Portable-5000mAh-Compatible-Android/dp/B093GKX5Z1) - [Auskang](https://www.amazon.com/Auskang-Portable-5000mAh-Compatible-Android/dp/B093GKX5Z1)
- [TNTOR](https://www.amazon.com/TNTOR-Portable-Charger-5000mAh-Compatible/dp/B0C3QH7RYK/) - [TNTOR](https://www.amazon.com/TNTOR-Portable-Charger-5000mAh-Compatible/dp/B0C3QH7RYK)