Shreyas Meher commited on
Commit
6786c31
·
unverified ·
1 Parent(s): 7e681cc

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +16 -5
README.md CHANGED
@@ -25,19 +25,30 @@ A web-based interface for ConfliBERT, a BERT-based model specialized in conflict
25
 
26
  ## Installation
27
 
28
- 1. Clone the repository to a local directory (do not clone to cloud storage, venv installs will be very slow if you do):
29
  ```bash
30
- git clone https://github.com/shreyasmeher/conflibert-gui.git
31
  cd conflibert-gui
32
  ```
33
 
34
- 2. Create and activate a virtual environment:
35
  ```bash
 
36
  python -m venv env
37
- source env/bin/activate # On Windows, use: env\Scripts\activate
 
 
 
 
 
 
 
 
 
 
38
  ```
39
 
40
- 3. Install required packages:
41
  ```bash
42
  pip install -r requirements.txt
43
  ```
 
25
 
26
  ## Installation
27
 
28
+ 1. Clone the repository to a local directory:
29
  ```bash
30
+ git clone https://github.com/shreyasmeyer/conflibert-gui.git
31
  cd conflibert-gui
32
  ```
33
 
34
+ 2. Create and activate virtual environment:
35
  ```bash
36
+ # Create environment
37
  python -m venv env
38
+
39
+ # Activate environment
40
+ # On Windows:
41
+ env\Scripts\activate
42
+ # On Mac/Linux:
43
+ source env/bin/activate
44
+ ```
45
+
46
+ 3. For Windows users, if you get permission errors, run PowerShell as Administrator and execute:
47
+ ```powershell
48
+ Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope LocalMachine
49
  ```
50
 
51
+ 4. Install requirements:
52
  ```bash
53
  pip install -r requirements.txt
54
  ```