copilot-swe-agent[bot] cjgaspari commited on
Commit
01475c1
·
1 Parent(s): 9687a71

Address code review feedback: improve accuracy of instructions

Browse files

Co-authored-by: cjgaspari <3847902+cjgaspari@users.noreply.github.com>

Files changed (1) hide show
  1. detailed-setup.md +9 -6
detailed-setup.md CHANGED
@@ -70,7 +70,7 @@ Conda creates isolated "environments" for different projects, so they don't inte
70
  ```bash
71
  conda --version
72
  ```
73
- - You should see something like `conda 24.x.x` (the exact version number may vary)
74
  - **If you get an error** saying "conda: command not found":
75
  - Close Terminal completely and open it again
76
  - Try the command again
@@ -85,7 +85,7 @@ Now we need to download the SHARP project files to your computer.
85
  ### Option A: Download via GitHub (Easiest for Beginners)
86
 
87
  1. **Go to the GitHub repository:**
88
- - Visit: https://github.com/apple/ml-sharp (or the repository URL where this project is hosted)
89
 
90
  2. **Download the ZIP file:**
91
  - Click the green **"Code"** button
@@ -108,10 +108,12 @@ If you're comfortable with Git or have it installed:
108
 
109
  ```bash
110
  cd ~/Documents
111
- git clone https://github.com/apple/ml-sharp.git
112
  cd ml-sharp
113
  ```
114
 
 
 
115
  ---
116
 
117
  ## Step 3: Set Up the Project
@@ -325,10 +327,11 @@ If the automatic script doesn't work, don't worry! Here's how to start it manual
325
 
326
  2. **Or modify the port in the app.py file:**
327
  - Open `src/sharp/web/app.py` in a text editor
328
- - Find the last line: `uvicorn.run(app, host="0.0.0.0", port=8000)`
329
- - Change `port=8000` to `port=8080` (or another port)
 
330
  - Save the file and start the server again
331
- - Then access it at: http://localhost:8080
332
 
333
  ### The Web Interface Won't Load
334
 
 
70
  ```bash
71
  conda --version
72
  ```
73
+ - You should see something like `conda X.X.X` (the exact version number may vary)
74
  - **If you get an error** saying "conda: command not found":
75
  - Close Terminal completely and open it again
76
  - Try the command again
 
85
  ### Option A: Download via GitHub (Easiest for Beginners)
86
 
87
  1. **Go to the GitHub repository:**
88
+ - Visit the repository URL where this project is hosted (check the address bar or the project README for the correct URL)
89
 
90
  2. **Download the ZIP file:**
91
  - Click the green **"Code"** button
 
108
 
109
  ```bash
110
  cd ~/Documents
111
+ git clone <repository-url>
112
  cd ml-sharp
113
  ```
114
 
115
+ (Replace `<repository-url>` with the actual Git URL from the GitHub repository)
116
+
117
  ---
118
 
119
  ## Step 3: Set Up the Project
 
327
 
328
  2. **Or modify the port in the app.py file:**
329
  - Open `src/sharp/web/app.py` in a text editor
330
+ - Look for the line near the end: `uvicorn.run(app, host="0.0.0.0", port=8000)`
331
+ (Tip: Search for `port=` to find it quickly)
332
+ - Change `port=8000` to `port=8080` (or another available port number)
333
  - Save the file and start the server again
334
+ - Then access it at: http://localhost:8080 (or your chosen port)
335
 
336
  ### The Web Interface Won't Load
337