-
Notifications
You must be signed in to change notification settings - Fork 79
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fixing inconsistencies and updating instructions for the InstallationInstructions.md file. #162
base: master
Are you sure you want to change the base?
Changes from all commits
3db8ea4
c79b5fc
9ea06ba
7709e99
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,7 +5,7 @@ | |
* [For MacOS](#for-macos) | ||
|
||
# For Windows | ||
The first step is to install the ESP-IDF v4.2. | ||
The first step is to install the ESP-IDF v5.2. | ||
|
||
## Step 1:Download the installer from [here](https://dl.espressif.com/dl/esp-idf/?idf=5.2) | ||
Please download the **offline** version pointed by the | ||
|
@@ -105,19 +105,17 @@ sudo chmod +x wall_e_install.sh | |
|
||
|
||
## For MacOS | ||
### STEP 1 : Installing the necessary file | ||
- Download the file "wall_e_install.sh" given in the root folder itself and put it in the "Downloads" folder | ||
- Download the driver by clicking on this [link](https://www.silabs.com/documents/public/software/Mac_OSX_VCP_Driver.zip) , unzip it, then install it on the system | ||
|
||
### STEP 2 : Opening The Terminal | ||
### STEP 1 : Opening The Terminal | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do the similar changes for Linux as well i.e. installing wget and then fetching the script. Cloning the repo explicitly is not required. |
||
Open the terminal by pressing command+space and then typing terminal. | ||
|
||
**Note:** If you're an M1 mac os user refer this [link](https://youtu.be/9W8rTTE1WEA) to open the terminal. | ||
|
||
### STEP 3 : Installing the Pre-Requisites | ||
Copy this command in the command in the terminal , then press return | ||
### STEP 2 : Installing the necessary file | ||
- Download the driver by executing the following command in the terminal. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Installation of this driver can be removed as we are using CH340C which is downloaded automatically when detected. Probably this can be added as a note as well for clarity. |
||
```sh | ||
source ~/Downloads/wall_e_install.sh | ||
curl https://raw.githubusercontent.com/SRA-VJTI/Wall-E/refs/heads/master/wall_e_install.sh -o wall_e_install.sh | ||
sudo chmod +x wall_e_install.sh | ||
./wall_e_install.sh | ||
``` | ||
Note:- when you are asked to type the password in the terminal, password will not be visible to you. Just type the password and then press return. | ||
|
||
|
@@ -133,7 +131,7 @@ Cloning the Wall-E Git repo | |
To clone the repo,execute the following commands on terminal. | ||
```sh | ||
cd $HOME | ||
git clone https://github.com/SRA-VJTI/Wall-E.git --recurse-submodules | ||
git clone https://github.com/SRA-VJTI/Wall-E.git --recursive --depth 1 | ||
cd Wall-E | ||
``` | ||
<p align="center"> | ||
|
@@ -168,8 +166,7 @@ ls | |
|
||
* For Windows - | ||
```powershell | ||
cd ~/Projects/Wall-E | ||
xcopy /e /i %IDF_PATH%\examples\get-started\hello_world hello_world | ||
cd ~/Projects/Wall-E/1_led_blink | ||
``` | ||
|
||
### Step 2 : Connect Your Device | ||
|
@@ -210,7 +207,6 @@ idf.py menuconfig # Command for Opening the Configuration Menu | |
``` | ||
* For Windows - | ||
```powershell | ||
cd ~/Projects/Wall-E/1_led_blink #Navigating to the file | ||
idf.py set-target esp32 #Command for Setting the Target | ||
idf.py menuconfig #Command for Opening the Configuration | ||
``` | ||
|
@@ -251,5 +247,3 @@ and for **windows** COM1 can be replaced by other number depending on the port t | |
```sh | ||
idf.py flash monitor | ||
``` | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cloning the repository separately is not required as the installation script includes it. Follow the notion and update it accordingly i.e. installing brew and then using curl to access the script