Spaces:
Sleeping
Sleeping
docs(README.md): add 'Pre-requisites' and 'How to run' sections
Browse files
README.md
CHANGED
|
@@ -10,4 +10,48 @@ pinned: false
|
|
| 10 |
license: lgpl-3.0
|
| 11 |
---
|
| 12 |
|
| 13 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 10 |
license: lgpl-3.0
|
| 11 |
---
|
| 12 |
|
| 13 |
+
## 🔧 Pre-requisites
|
| 14 |
+
|
| 15 |
+
Before running the project, you must have the following tool installed on your machine:
|
| 16 |
+
* [Python v3.8.0](https://www.python.org/downloads/release/python-380/)
|
| 17 |
+
|
| 18 |
+
Also, you will need to clone the repository:
|
| 19 |
+
|
| 20 |
+
```bash
|
| 21 |
+
# Clone the repository
|
| 22 |
+
git clone https://huggingface.co/spaces/mateuseap/magic-vocals/
|
| 23 |
+
# Enter in the root directory
|
| 24 |
+
cd magic-vocals
|
| 25 |
+
```
|
| 26 |
+
|
| 27 |
+
## 🚀 How to run
|
| 28 |
+
|
| 29 |
+
After you've cloned the repository and entered in the root directory, run the following commands:
|
| 30 |
+
|
| 31 |
+
```bash
|
| 32 |
+
# Create and activate a Virtual Environment (make sure you're using Python v3.8.0 to do it)
|
| 33 |
+
python -m venv venv
|
| 34 |
+
. venv/bin/activate
|
| 35 |
+
|
| 36 |
+
# Change mode and execute a shell script to configure and run the application
|
| 37 |
+
chmod +x run.sh
|
| 38 |
+
./run.sh
|
| 39 |
+
```
|
| 40 |
+
|
| 41 |
+
After the shell script executes everything, the application will be running at http://127.0.0.1:7860! Open up the link in a browser to use the app:
|
| 42 |
+
|
| 43 |
+

|
| 44 |
+
|
| 45 |
+
**You only need to execute the `run.sh` one time**, once you've executed it one time, you just need to activate the virtual environment and run the command below to start the app again:
|
| 46 |
+
|
| 47 |
+
```bash
|
| 48 |
+
python app.py
|
| 49 |
+
```
|
| 50 |
+
|
| 51 |
+
**THE `run.sh` IS SUPPORTED BY THE FOLLOWING OPERATING SYSTEMS:**
|
| 52 |
+
|
| 53 |
+
|
| 54 |
+
| OS | Supported |
|
| 55 |
+
|-----------|:---------:|
|
| 56 |
+
| `Windows` | ❌ |
|
| 57 |
+
| `Ubuntu` | ✅ |
|