Skip to content

Commit 0d0ff6b

Browse files
committed
[v0.2.2] Updated README.md
1 parent d1364df commit 0d0ff6b

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,23 @@ It is really helpful if you want to download a mod or modpack containing various
3333
4. The first step of loading dependencies take some time as it download [chromium-drivers](https://github.com/yeongbin-jo/python-chromedriver-autoinstaller) (~30-35 MB) required for loading URLs and the mods for downloading.
3434
5. Once completed the application will show a download complete dialog.
3535

36+
37+
### Development
38+
1. You can build and run the app yourself. I have written the code in python and implemented poetry for dependency mamagement and easy build.
39+
2. Install python > v3.12 and install poetry, refer to [poetry official website](https://python-poetry.org/docs/#installation) for installation guide.
40+
3. Install dependencies via the command `poetry install`.
41+
4. To run the application use the command `poetry run factorio-mod-downloader`. This will run the application to be used.
42+
5. To build the application, I am using pyinstaller (you need a **Windows x64** system to build it). Run the command `poetry build` to build the application. A new .exe file will be generated inside `/dist/pyinstaller/win_amd64`.
43+
44+
3645
### Note
3746
I have not included optional dependencies, as its a stupid idea, since a lots of mods, even they don't need something have optional dependencies mentioned. So it will probably take forever to finish downloading. It can be implemented although. Not a big task.
3847

3948
Also, download speed is based on re146, Its not super fast but its fine.
4049

4150
Feel free to reach out to me or start a message in the discussions tab if you need some help.
4251

52+
4353
### Credits:
4454
- re146.dev
4555
- [radioegor146](https://github.com/radioegor146)

0 commit comments

Comments
 (0)