Borg93 commited on
Commit
8e99520
·
unverified ·
1 Parent(s): 60d8ae5

Update README.md for install miss bug #5

Browse files
Files changed (1) hide show
  1. .github/README.md +39 -15
.github/README.md CHANGED
@@ -114,27 +114,51 @@ The final pipeline step determines the reading order of the text. In this exampl
114
 
115
  ### Installation
116
 
117
- 1. **Clone the Repository:**
118
 
119
- ```bash
120
- git clone https://github.com/your_username/htrflow_app.git
121
- cd htrflow_app
122
- ```
123
 
124
- 2. **Set Up a Virtual Environment:**
125
 
126
- ```bash
127
- python3 -m venv .venv
128
- source .venv/bin/activate # On Windows: .venv\Scripts\activate
129
- ```
 
130
 
131
- 3. **Install Dependencies:**
132
 
133
- Since we are no longer using a Makefile, install the required packages with:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
134
 
135
- ```bash
136
- pip install -r requirements.txt
137
- ```
138
 
139
  ### Running the Application Locally
140
 
 
114
 
115
  ### Installation
116
 
117
+ #### 1. Clone the Repository
118
 
119
+ ```bash
120
+ git clone https://github.com/your_username/htrflow_app.git
121
+ cd htrflow_app
122
+ ```
123
 
124
+ #### 2. Install **uv** Globally
125
 
126
+ Install **uv** without activating a virtual environment:
127
+
128
+ ```bash
129
+ pip install uv
130
+ ```
131
 
132
+ #### 3. Create a Virtual Environment Using **uv**
133
 
134
+ Create a virtual environment with Python 3.10:
135
+
136
+ ```bash
137
+ uv venv python 3.10
138
+ ```
139
+
140
+ #### 4. Activate the Virtual Environment
141
+
142
+ Activate your newly created virtual environment:
143
+
144
+ ```bash
145
+ source .venv/bin/activate # On Windows: .venv\Scripts\activate
146
+ ```
147
+
148
+ #### 5. Install Project Dependencies
149
+
150
+ For a one-time dependency sync, run:
151
+
152
+ ```bash
153
+ uv sync
154
+ ```
155
+
156
+ Or, if you are developing and prefer an editable installation, run:
157
+
158
+ ```bash
159
+ uv pip install -e .
160
+ ```
161
 
 
 
 
162
 
163
  ### Running the Application Locally
164