From 2ef732045eb1e88e8d7389e4b23af8526711211d Mon Sep 17 00:00:00 2001 From: Toby Nguyen Date: Thu, 16 Jan 2025 10:14:24 -0600 Subject: [PATCH] split setup into windows and macos sections --- .../designing-a-robot/3d-modeling/onshape.md | 2 +- .../environment-setup/environment-setup.md | 9 +++++ .../environment-setup/mac-setup.md | 36 +++++++++++++++++++ .../windows-setup.md} | 35 +++--------------- 4 files changed, 50 insertions(+), 32 deletions(-) create mode 100644 docs/_sections/_guide-primaries/getting-started/environment-setup/environment-setup.md create mode 100644 docs/_sections/_guide-primaries/getting-started/environment-setup/mac-setup.md rename docs/_sections/_guide-primaries/getting-started/{environment-setup.md => environment-setup/windows-setup.md} (92%) diff --git a/docs/_sections/_guide-primaries/designing-a-robot/3d-modeling/onshape.md b/docs/_sections/_guide-primaries/designing-a-robot/3d-modeling/onshape.md index cf0fb409..80529e14 100644 --- a/docs/_sections/_guide-primaries/designing-a-robot/3d-modeling/onshape.md +++ b/docs/_sections/_guide-primaries/designing-a-robot/3d-modeling/onshape.md @@ -3,7 +3,7 @@ layout: default title: Modeling with Onshape nav_include: true parent: 3D Modeling -grand_parent: Designing a Robot +grand_parent: Designing a Robot nav_order: 1 --- # 3D Modeling with Onshape diff --git a/docs/_sections/_guide-primaries/getting-started/environment-setup/environment-setup.md b/docs/_sections/_guide-primaries/getting-started/environment-setup/environment-setup.md new file mode 100644 index 00000000..4a606dba --- /dev/null +++ b/docs/_sections/_guide-primaries/getting-started/environment-setup/environment-setup.md @@ -0,0 +1,9 @@ +--- +layout: default +title: Environment Setup +nav_include: true +has_children: true +has_grand_children: true +parent: Getting Started +nav_order: 3 +--- \ No newline at end of file diff --git a/docs/_sections/_guide-primaries/getting-started/environment-setup/mac-setup.md b/docs/_sections/_guide-primaries/getting-started/environment-setup/mac-setup.md new file mode 100644 index 00000000..a64adb68 --- /dev/null +++ b/docs/_sections/_guide-primaries/getting-started/environment-setup/mac-setup.md @@ -0,0 +1,36 @@ +--- +layout: default +title: macOS Setup +nav_include: true +parent: Environment Setup +grand_parent: Getting Started +nav_order: 1 +--- + +## macOS Setup +https://docs.espressif.com/projects/vscode-esp-idf-extension/en/latest/installation.html + + + +https://docs.espressif.com/projects/esp-idf/en/stable/esp32/get-started/linux-macos-setup.html +TODO figure out what to do the setup script installs the CLI for esp-idf isntead of VS Code extension +proly just gona make them go through the install manually + + + + +### Install VS Code +TODO + +### Install Git +TODO + +### Install SiLabs UART-USB driver +1. Go to [SiLabs installer webpage](https://www.silabs.com/developer-tools/usb-to-uart-bridge-vcp-drivers?tab=downloads) + +Download the following file: +TODO: add picture + +1. Extract the downloaded zip file and run the appropriate installer application inside +1. Agree and use default configuration + diff --git a/docs/_sections/_guide-primaries/getting-started/environment-setup.md b/docs/_sections/_guide-primaries/getting-started/environment-setup/windows-setup.md similarity index 92% rename from docs/_sections/_guide-primaries/getting-started/environment-setup.md rename to docs/_sections/_guide-primaries/getting-started/environment-setup/windows-setup.md index dc98a40b..2ac8747a 100644 --- a/docs/_sections/_guide-primaries/getting-started/environment-setup.md +++ b/docs/_sections/_guide-primaries/getting-started/environment-setup/windows-setup.md @@ -1,9 +1,10 @@ --- layout: default -title: Environment Setup +title: Windows nav_include: true -parent: Getting Started -nav_order: 5 +parent: Environment Setup +grand_parent: Getting Started +nav_order: 1 --- # Environment Setup @@ -161,34 +162,6 @@ Do this even if you already have VS Code to minimize environment setup issues. Note: Building and flashing after the first time does not take nearly as long. In fact, you can press the Build, Flash, and Monitor button (fire icon) to streamline the process! {: .callout-blue} -## macOS Setup -https://docs.espressif.com/projects/vscode-esp-idf-extension/en/latest/installation.html - - - -https://docs.espressif.com/projects/esp-idf/en/stable/esp32/get-started/linux-macos-setup.html -TODO figure out what to do the setup script installs the CLI for esp-idf isntead of VS Code extension -proly just gona make them go through the install manually - - - - -### Install VS Code -TODO - -### Install Git -TODO - -### Install SiLabs UART-USB driver -1. Go to [SiLabs installer webpage](https://www.silabs.com/developer-tools/usb-to-uart-bridge-vcp-drivers?tab=downloads) - -Download the following file: -TODO: add picture - -1. Extract the downloaded zip file and run the appropriate installer application inside -1. Agree and use default configuration - - # Example Program