aboutsummaryrefslogtreecommitdiff
path: root/QUICKSTART.md
diff options
context:
space:
mode:
authorGravatar Donald Nwokoro <infect3dlab@gmail.com> 2023-10-19 11:20:32 +0100
committerGravatar GitHub <noreply@github.com> 2023-10-19 12:20:32 +0200
commit4b1e8f6e8b4186ec6563301c146fbf3425f92715 (patch)
treef764f1f1b89140d79ed71f3be0928d31e73f3dcf /QUICKSTART.md
parentupdated CLI-USAGE.md agents command to current agent command (#5805) (diff)
downloadAuto-GPT-4b1e8f6e8b4186ec6563301c146fbf3425f92715.tar.gz
Auto-GPT-4b1e8f6e8b4186ec6563301c146fbf3425f92715.tar.bz2
Auto-GPT-4b1e8f6e8b4186ec6563301c146fbf3425f92715.zip
Improved Documentation for Windows Users (#5410)
This commit introduces enhancements to the project's documentation, specifically targeted at Windows users who may encounter issues post installing WSL. The added content aims to facilitate a smoother setup experience by providing clear and concise solutions to common problems encountered during the installation process. Main Changes: - Instructions on updating WSL for resolving initial setup issues. - Solutions to fix ‘FileNotFoundError’ or ‘No such file or directory’ errors by addressing line-ending discrepancies between Windows and Unix/Linux systems. - Recommendations to store project files within the WSL file system for avoiding issues related to path translations and permissions. These changes are derived from personal experiences and are intended to prevent Windows users from spending additional time troubleshooting issues already resolved, allowing them to have a more consistent development environment setup. Lastly, a big shout-out to the developers and contributors for their ongoing efforts and commitment to maintaining and improving this project. Your hard work is greatly appreciated by the community!
Diffstat (limited to 'QUICKSTART.md')
-rw-r--r--QUICKSTART.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/QUICKSTART.md b/QUICKSTART.md
index d0776c267..86add5511 100644
--- a/QUICKSTART.md
+++ b/QUICKSTART.md
@@ -44,6 +44,39 @@ This project supports Linux (Debian based), Mac, and Windows Subsystem for Linux
![Setup the Project](docs/content/imgs/quickstart/005_setup.png)
+
+### For Windows Users
+
+If you're a Windows user and experience issues after installing WSL, follow the steps below to resolve them.
+
+#### Update WSL
+Run the following command in Powershell or Command Prompt to:
+1. Enable the optional WSL and Virtual Machine Platform components.
+2. Download and install the latest Linux kernel.
+3. Set WSL 2 as the default.
+4. Download and install the Ubuntu Linux distribution (a reboot may be required).
+
+```shell
+wsl --install
+```
+
+For more detailed information and additional steps, refer to [Microsoft's WSL Setup Environment Documentation](https://learn.microsoft.com/en-us/windows/wsl/setup/environment).
+
+#### Resolve FileNotFoundError or "No such file or directory" Errors
+When you run `./run setup`, if you encounter errors like `No such file or directory` or `FileNotFoundError`, it might be because Windows-style line endings (CRLF - Carriage Return Line Feed) are not compatible with Unix/Linux style line endings (LF - Line Feed).
+
+To resolve this, you can use the `dos2unix` utility to convert the line endings in your script from CRLF to LF. Here’s how to install and run `dos2unix` on the script:
+
+```shell
+sudo apt update
+sudo apt install dos2unix
+dos2unix ./run
+```
+
+After executing the above commands, running `./run setup` should work successfully.
+
+#### Store Project Files within the WSL File System
+If you continue to experience issues, consider storing your project files within the WSL file system instead of the Windows file system. This method avoids issues related to path translations and permissions and provides a more consistent development environment.
You can keep running the command to get feedback on where you are up to with your setup.
When setup has been completed, the command will return an output like this: