diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 7dcb61ea5dc0..1359e561691f 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -5,7 +5,7 @@ "build": { "dockerfile": "Dockerfile", "context": "..", - "args": { + "args": { // Update 'VARIANT' to pick a Python version: 3, 3.6, 3.7, 3.8, 3.9 "VARIANT": "3.9.0-buster", // Options @@ -15,7 +15,7 @@ }, // Set *default* container specific settings.json values on container create. - "settings": { + "settings": { "python.pythonPath": "/usr/local/bin/python", "python.languageServer": "Pylance", "python.linting.enabled": true, diff --git a/README.md b/README.md index 1b9f2cbd3b20..845dd7127ead 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,10 @@ Download earlier versions of Marlin on the [Releases page](https://github.com/Ma To build Marlin 2.0 you'll need [Arduino IDE 1.8.8 or newer](https://www.arduino.cc/en/main/software) or [PlatformIO](https://docs.platformio.org/en/latest/ide.html#platformio-ide). We've posted detailed instructions on [Building Marlin with Arduino](https://marlinfw.org/docs/basics/install_arduino.html) and [Building Marlin with PlatformIO for ReArm](https://marlinfw.org/docs/basics/install_rearm.html) (which applies well to other 32-bit boards). +- [Installing Marlin (Arduino)](http://marlinfw.org/docs/basics/install_arduino.html) +- [Installing Marlin (VSCode)](http://marlinfw.org/docs/basics/install_platformio_vscode.html). +- [Installing Marlin (VSCode devcontainer)](docs/using-devcontainer-with-vscode.md). + ## Hardware Abstraction Layer (HAL) Marlin 2.0 introduces a layer of abstraction so that all the existing high-level code can be built for 32-bit platforms while still retaining full 8-bit AVR compatibility. Retaining AVR compatibility and a single code-base is important to us, because we want to make sure that features and patches get as much testing and attention as possible, and that all platforms always benefit from the latest improvements. @@ -83,10 +87,11 @@ Marlin 2.0 introduces a layer of abstraction so that all the existing high-level ----|---------|-----|-----|----|-----|--- [Teensy++ 2.0](https://www.microchip.com/wwwproducts/en/AT90USB1286)|[AT90USB1286](https://www.microchip.com/wwwproducts/en/AT90USB1286)|16MHz|128k|8k|5V|no - - [Installing Marlin (Arduino)](http://marlinfw.org/docs/basics/install_arduino.html) - - [Installing Marlin (VSCode)](http://marlinfw.org/docs/basics/install_platformio_vscode.html). - - [Installing Marlin (VSCode devcontainer)](docs/using-devcontainer-with-vscode.md). -### Supported Platforms + #### Teensy 3.1 / 3.2 + + boards|processor|speed|flash|sram|logic|fpu + ----|---------|-----|-----|----|-----|--- + [Teensy 3.2](https://www.pjrc.com/store/teensy32.html)|[MK20DX256VLH7](https://www.mouser.com/ProductDetail/NXP-Freescale/MK20DX256VLH7) ARM-Cortex M4|72MHz|256k|32k|3.3V-5V|yes #### Teensy 3.5 / 3.6 diff --git a/docs/using-devcontainer-with-vscode.md b/docs/using-devcontainer-with-vscode.md index 1ba6d2f72323..6bae44739a32 100644 --- a/docs/using-devcontainer-with-vscode.md +++ b/docs/using-devcontainer-with-vscode.md @@ -19,17 +19,16 @@ The dev container official documentation can be found [here](https://code.visual This quick start covers how to set up a dev container for an existing project to use as your full-time development environment using existing source code on your filesystem. Follow these steps: -1. Start VS Code, run the **Remote-Containers: Open Folder in Container...** command from the Command Palette (F1) or quick actions Status bar item, and select the Marlin project folder. - +1. Start VSCode, run the **Remote-Containers: Open Folder in Container...** command from the Command Palette (F1) or quick actions Status bar item, and select the Marlin project folder. + ![Quick actions Status bar item](https://code.visualstudio.com/assets/docs/remote/common/remote-dev-status-bar.png) - -2. The VS Code window will reload and start building the dev container. A progress notification provides status updates. You only have to build a dev container the first time you open it; opening the folder after the first successful build will be much quicker. - + +2. The VSCode window will reload and start building the dev container. A progress notification provides status updates. You only have to build a dev container the first time you open it; opening the folder after the first successful build will be much quicker. + ![Dev Container Progress Notification](https://code.visualstudio.com/assets/docs/remote/containers/dev-container-progress.png) - -3. After the build completes, VS Code will automatically connect to the container. - -You can now interact with your project in VS Code just as you could when opening the project locally. From now on, when you open the project folder, VS Code will automatically pick up and reuse your dev container configuration. +3. After the build completes, VSCode will automatically connect to the container. + +You can now interact with your project in VSCode just as you could when opening the project locally. From now on, when you open the project folder, VSCode will automatically pick up and reuse your dev container configuration. -While using this approach to [bind mount](https://docs.docker.com/storage/bind-mounts/) the local filesystem into a container is convenient, it does have some performance overhead on Windows and macOS. There are [some techniques](https://code.visualstudio.com/docs/remote/containers-advanced#_improving-container-disk-performance) that you can apply to improve disk performance, or you can [open a repository in a container using a isolated container volume](https://code.visualstudio.com/docs/remote/containers#_quick-start-open-a-git-repository-or-github-pr-in-an-isolated-container-volume) instead. \ No newline at end of file +While using this approach to [bind mount](https://docs.docker.com/storage/bind-mounts/) the local filesystem into a container is convenient, it does have some performance overhead on Windows and macOS. There are [some techniques](https://code.visualstudio.com/docs/remote/containers-advanced#_improving-container-disk-performance) that you can apply to improve disk performance, or you can [open a repository in a container using a isolated container volume](https://code.visualstudio.com/docs/remote/containers#_quick-start-open-a-git-repository-or-github-pr-in-an-isolated-container-volume) instead.