Update README.md
Browse files
README.md
CHANGED
|
@@ -71,31 +71,43 @@ We ask you to please watch over the growth of this small but great life with war
|
|
| 71 |
|
| 72 |
Follow these instructions to get Hongik AI running on your local machine.
|
| 73 |
|
| 74 |
-
|
| 75 |
|
| 76 |
This project requires the following to be installed on your system:
|
| 77 |
* Python 3.10.12 or higher
|
| 78 |
* pip (Python package installer)
|
| 79 |
* Git & Git LFS
|
| 80 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 81 |
git clone [https://huggingface.co/puco21/HongikAI](https://huggingface.co/puco21/HongikAI)
|
| 82 |
cd HongikAI
|
| 83 |
|
|
|
|
| 84 |
git lfs install
|
| 85 |
git lfs pull
|
| 86 |
|
| 87 |
-
|
|
|
|
|
|
|
| 88 |
|
| 89 |
-
|
| 90 |
For the GUI to function correctly on Linux, system-level dependencies for Kivy are required.
|
| 91 |
(Debian/Ubuntu command is provided in your original text)
|
| 92 |
|
| 93 |
-
|
| 94 |
Bash
|
| 95 |
-
python __main__.py
|
| 96 |
|
|
|
|
| 97 |
Contact
|
| 98 |
Developer: Namyong Park
|
|
|
|
| 99 |
Contributor: Minji Seo, Hyeonji Seong
|
| 100 |
|
| 101 |
Email: puco21@gmail.com
|
|
|
|
| 71 |
|
| 72 |
Follow these instructions to get Hongik AI running on your local machine.
|
| 73 |
|
| 74 |
+
### 1. Prerequisites
|
| 75 |
|
| 76 |
This project requires the following to be installed on your system:
|
| 77 |
* Python 3.10.12 or higher
|
| 78 |
* pip (Python package installer)
|
| 79 |
* Git & Git LFS
|
| 80 |
|
| 81 |
+
### 2. Clone the Repository & Download Large Files
|
| 82 |
+
|
| 83 |
+
```bash
|
| 84 |
+
# First, install Git LFS if you haven't already
|
| 85 |
+
# For Debian/Ubuntu:
|
| 86 |
+
sudo apt-get install git-lfs
|
| 87 |
+
|
| 88 |
+
1. Clone the repository
|
| 89 |
git clone [https://huggingface.co/puco21/HongikAI](https://huggingface.co/puco21/HongikAI)
|
| 90 |
cd HongikAI
|
| 91 |
|
| 92 |
+
2. Download the large font files tracked by LFS
|
| 93 |
git lfs install
|
| 94 |
git lfs pull
|
| 95 |
|
| 96 |
+
3. Install Dependencies
|
| 97 |
+
Bash
|
| 98 |
+
pip install -r requirements.txt
|
| 99 |
|
| 100 |
+
4. System Prerequisites (Linux Only)
|
| 101 |
For the GUI to function correctly on Linux, system-level dependencies for Kivy are required.
|
| 102 |
(Debian/Ubuntu command is provided in your original text)
|
| 103 |
|
| 104 |
+
5. Run the Application
|
| 105 |
Bash
|
|
|
|
| 106 |
|
| 107 |
+
python __main__.py
|
| 108 |
Contact
|
| 109 |
Developer: Namyong Park
|
| 110 |
+
|
| 111 |
Contributor: Minji Seo, Hyeonji Seong
|
| 112 |
|
| 113 |
Email: puco21@gmail.com
|