diff --git a/README.md b/README.md index 1ac85a217f33c07e13be712e8945d21305d92036..970f04c1fb0d4df7c7947081bca563cf85ec8667 100644 --- a/README.md +++ b/README.md @@ -1,93 +1,3 @@ # Carvera PCB tutorial - - -## Getting started - -To make it easy for you to get started with GitLab, here's a list of recommended next steps. - -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! - -## Add your files - -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: - -``` -cd existing_repo -git remote add origin https://gitlab.cba.mit.edu/quentinbolsee/carvera-pcb-tutorial.git -git branch -M main -git push -uf origin main -``` - -## Integrate with your tools - -- [ ] [Set up project integrations](https://gitlab.cba.mit.edu/quentinbolsee/carvera-pcb-tutorial/-/settings/integrations) - -## Collaborate with your team - -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) - -## Test and Deploy - -Use the built-in continuous integration in GitLab. - -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) - -*** - -# Editing this README - -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template. - -## Suggestions for a good README - -Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. - -## Name -Choose a self-explaining name for your project. - -## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. - -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. - -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. - -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. - -## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. - -## Support -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. - -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. - -## Contributing -State if you are open to contributions and what your requirements are for accepting them. - -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. - -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. - -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. - -## License -For open source projects, say how it is licensed. - -## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. +Served at [https://quentinbolsee.pages.cba.mit.edu/carvera-pcb-tutorial/](https://quentinbolsee.pages.cba.mit.edu/carvera-pcb-tutorial/) diff --git a/img/cc-probe-settings.png b/img/cc-probe-settings.png new file mode 100644 index 0000000000000000000000000000000000000000..a4ce88109f54aaf443e2692a8aa343507e15ba9c Binary files /dev/null and b/img/cc-probe-settings.png differ diff --git a/img/tools.jpg b/img/tools.jpg index 4e899e36ebf6034b0424d9ead8bb808dfb989c4d..5350b7df47fd8d8fb70aa3da57112e744905951d 100644 Binary files a/img/tools.jpg and b/img/tools.jpg differ diff --git a/index.html b/index.html index 540dfdbcc37969c14b2ca5c43012caa46e2e02b6..0abccf2631fac71afad9c4bb6fa66d9edead600d 100644 --- a/index.html +++ b/index.html @@ -4,7 +4,7 @@ <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width"> -<title>HTBAA: amaretti</title> +<title>Carvera PCB tutorial</title> <link href="style.css" rel="stylesheet" type="text/css" /> </head> @@ -68,10 +68,10 @@ For the purpose of PCB milling, we'll assume the machine has the following tools <ul> <li>Tool n°3: 1/32" (0.8mm) flat end mill</li> - <li>Tool n°5: 1/64" (0.4mm) flat end mill</li> + <li>Tool n°4: 1/64" (0.4mm) flat end mill</li> </ul> -The 1/64" flat end mill as tool n°5 is not what the machine comes with out of the box. Instead, you can use the 30° 0.2mm V bit the machine has as tool n°2 by default, but V bits tend to leave a lot of burs on milled PCBs. A thin flat end mill is more delicate but worth it for milling quality. +The 1/64" flat end mill as tool n°4 is not what the machine comes with out of the box. Instead, you can use the 30° 0.2mm V bit the machine has as tool n°2 by default, but V bits tend to leave a lot of burs on milled PCBs. A thin flat end mill is more delicate but worth it for milling quality. </p> <a href="./img/tools.jpg" target=_blank><img src="./img/tools.jpg"/></a> @@ -170,6 +170,27 @@ Click on "Ok" to confirm. Next, let's configure auto-leveling with the probe. Ti <a href="./img/cc-probe.png" target=_blank><img src="./img/cc-probe.png"/></a> +<p> +In the new dialog box, use the following settings: + +<ul> + <li><b>Clearance height</b>: 2mm</li> + <li><b>X points</b>: 3</li> + <li><b>Y points</b>: 3</li> +</ul> + +If your board is large, you can use 5 points instead of 3. +</p> + +<a href="./img/cc-probe-settings.png" target=_blank><img src="./img/cc-probe-settings.png"/></a> + +<p> +Click on "Ok" to confirm, then click on "Run" to launch the job. The machine will pick up the probe first, and use a laser pointer to show you the margin of your program. +<b>If those margins go beyond the copper clad or overlap with the clamps, STOP the machine by clicking on the red stop icon.</b> Go back to the configuration, and correct the X and Y offsets so that your program does not crash the machine in anything. +</p> + + + <h2>4. Removing your board and cleaning up</h2> </main>