Paillat-dev/viralfactory
1
0
Fork 0
mirror of https://github.com/Paillat-dev/viralfactory.git synced 2026-01-02 01:06:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

📝 Update readme to use pdm and improve contributing

Browse Source
This commit is contained in:
Paillat
2024-05-15 09:15:44 +02:00
parent ced0c95d5d
commit b694183636
1 changed files with 6 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -72,6 +72,7 @@ You will need as well to have the following software installed (click on them to
- [ffmpeg](https://ffmpeg.org/download.html) - [ffmpeg](https://ffmpeg.org/download.html)
- [git](https://git-scm.com/downloads) - [git](https://git-scm.com/downloads)
- [Python 3.10](https://www.python.org/downloads/release/python-31011/) - [Python 3.10](https://www.python.org/downloads/release/python-31011/)
- [PDM](https://pdm-project.org/en/latest/)
### Installation ### Installation
@@ -79,10 +80,9 @@ Once the above requirements are installed, reboot your computer. Then, open a te
```bash ```bash
git clone https://github.com/Paillat-dev/viralfactory git clone https://github.com/Paillat-dev/viralfactory
cd viralfactory cd viralfactory
py -3.10 -m venv venv pdm install
.\venv\Scripts\activate # Windows # or for development
source venv/bin/activate # Linux & MacOS pdm install --dev
pip install -r requirement.txt
``` ```
This might take some time, you should not worry about it seeming stuck. This might take some time, you should not worry about it seeming stuck.
@@ -90,9 +90,7 @@ This might take some time, you should not worry about it seeming stuck.
You can launch the webapp with: You can launch the webapp with:
```bash ```bash
.\venv\Scripts\activate # Windows pdm run start
source venv/bin/activate # Linux & MacOS
python main.py
``` ```
Watch the video below to learn more on how to use. Watch the video below to learn more on how to use.
@@ -114,7 +112,7 @@ Contributions are what make the open source community such an amazing place to b
1. Fork the Project 1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m '✨feat(Engines.LLMEngine) Add mistral local engine'`) 3. Commit your Changes (`git commit -m '✨feat(Engines.LLMEngine) Add ollama local engine'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`) 4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request 5. Open a Pull Request