Shreyas Meher commited on
Commit
4a37580
·
unverified ·
1 Parent(s): 6786c31

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +26 -4
README.md CHANGED
@@ -25,13 +25,35 @@ 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:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
@@ -43,12 +65,12 @@ env\Scripts\activate
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
  ```
 
25
 
26
  ## Installation
27
 
28
+ # Requirements
29
+
30
+ **Required:**
31
+ - Python 3.8+
32
+ - Git
33
+ - Code editor (VS Code recommended)
34
+
35
+ **Optional but recommended:**
36
+ - PowerShell 5.0+ (Windows)
37
+ - Terminal (Mac)
38
+
39
+ # Installation Steps
40
+
41
+ 1. Install Python:
42
+ - Download from [python.org](https://www.python.org/downloads/)
43
+ - Check installation: `python --version`
44
+
45
+ 2. Install Git:
46
+ - Windows: Download from [git-scm.com](https://git-scm.com/downloads)
47
+ - Mac: `brew install git` or download from [git-scm.com](https://git-scm.com/downloads)
48
+ - Check installation: `git --version`
49
+
50
+ 3. Clone repository:
51
  ```bash
52
  git clone https://github.com/shreyasmeyer/conflibert-gui.git
53
  cd conflibert-gui
54
  ```
55
 
56
+ 4. Create and activate virtual environment:
57
  ```bash
58
  # Create environment
59
  python -m venv env
 
65
  source env/bin/activate
66
  ```
67
 
68
+ 5. For Windows users with permission errors, run PowerShell as Administrator:
69
  ```powershell
70
  Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope LocalMachine
71
  ```
72
 
73
+ 6. Install requirements:
74
  ```bash
75
  pip install -r requirements.txt
76
  ```