drewThomasson commited on
Commit
7bc2b77
·
verified ·
1 Parent(s): 88c6e5f

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +123 -3
README.md CHANGED
@@ -1,3 +1,123 @@
1
- ---
2
- license: mit
3
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: mit
3
+ ---
4
+
5
+ ### The NLTK zip file is for this guide here for manually installing the missing nltk files
6
+ It's not that bad lol, just copy a folder lol.
7
+
8
+ ### Installing NLTK in WSL Environment Manually
9
+
10
+ 1. **Launch the WSL Environment**
11
+ - Open your PowerShell and run:
12
+ ```sh
13
+ wsl -d Ubuntu
14
+ ```
15
+
16
+ 2. **Access the WSL Filesystem in Windows File Explorer**
17
+ - Navigate to the following path:
18
+ ```
19
+ \\wsl$\Ubuntu\home\USERNAME\miniconda\envs\VoxNovel\lib\python3.10\site-packages
20
+ ```
21
+ - Replace `USERNAME` with the username you set up when configuring WSL.
22
+
23
+ 3. **Replace the NLTK Files**
24
+ - Download and unzip the NLTK files [nltk.zip](https://github.com/user-attachments/files/16650539/nltk.zip).
25
+ - Copy the unzipped `nltk` folder and paste it into the directory from step 2.
26
+ - When prompted to replace files, select "Yes" to overwrite any existing files.
27
+
28
+ 4. **Done!**
29
+ - Test the installation by going back to your WSL Ubuntu environment:
30
+ ```sh
31
+ python
32
+ ```
33
+ - Then, try importing NLTK:
34
+ ```python
35
+ import nltk
36
+ ```
37
+ - If everything works correctly, you can now continue where you left off.
38
+
39
+ ---
40
+
41
+ <details>
42
+ <summary>Easy Windows 11 Installation Guide for VoxNovel</summary>
43
+
44
+ ### Watch the Installation Video
45
+ [Watch here](https://youtu.be/OmJub3uvfz4).
46
+
47
+ ### Step-by-Step Instructions
48
+
49
+ 1. **Install WSL**
50
+ - In PowerShell, run:
51
+ ```sh
52
+ wsl --install
53
+ ```
54
+ - You might be prompted to enable virtualization in your BIOS if it's not already enabled.
55
+
56
+ 2. **Set Up WSL**
57
+ - After setting your username and password in WSL, run the following command to install everything needed for VoxNovel:
58
+ ```sh
59
+ yes | wget -O - https://raw.githubusercontent.com/DrewThomasson/VoxNovel/main/shell_install_scripts/Ubuntu-install.sh | bash
60
+ ```
61
+
62
+ 3. **(Optional: NVIDIA Graphics Card Users Only)**
63
+ - Install the NVIDIA CUDA toolkit for GPU acceleration:
64
+ ```sh
65
+ sudo apt install nvidia-cuda-toolkit
66
+ ```
67
+
68
+ 4. **Activate the VoxNovel Conda Environment**
69
+ - Make sure you're in the VoxNovel environment:
70
+ ```sh
71
+ conda activate VoxNovel
72
+ ```
73
+ - If you see an error like `conda: command not found`, close PowerShell and relaunch WSL with:
74
+ ```sh
75
+ wsl -d Ubuntu
76
+ ```
77
+
78
+ 5. **Navigate to the VoxNovel Folder**
79
+ - If not already in the folder, run:
80
+ ```sh
81
+ cd ~ && cd VoxNovel
82
+ ```
83
+
84
+ 6. **Congrats!**
85
+ - VoxNovel should now be running in WSL.
86
+
87
+ ### 🚀 To Run the Program
88
+ ```sh
89
+ python gui_run.py
90
+ ```
91
+
92
+ ### 🚀 Or to Run Headless
93
+ ```sh
94
+ python headless_voxnovel.py
95
+ ```
96
+
97
+ ### Troubleshooting WSL
98
+
99
+ 1. **List All WSL Environments**
100
+ ```sh
101
+ wsl --list --verbose
102
+ ```
103
+
104
+ 2. **Remove a Specific WSL Environment**
105
+ ```sh
106
+ wsl --unregister <distro_name>
107
+ ```
108
+
109
+ 3. **Reinstall WSL**
110
+ ```sh
111
+ wsl --install
112
+ ```
113
+
114
+ To launch WSL anytime, you can use the search bar in Windows to find and launch "WSL" or run:
115
+ ```sh
116
+ wsl
117
+ ```
118
+
119
+ </details>
120
+
121
+ ---
122
+
123
+ This format is clear and well-organized, making it easier for users to follow the steps.