diff --git a/README.md b/README.md index 6a5e6cb..36af749 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,38 @@ -GVM -=============== +# GVM -A Godot Version Manager written in Python \ No newline at end of file +A Godot Version Manager written in Python. +You can download launch and remove **(WIP)** stable Godot versions.
+It's for people who want an unified experience of managing Godot +instead of losing track of every sole version they use. + +## Dependencies + +You need **[requests](https://pypi.org/project/requests/)** for the application to work.
+Pyinstaller is only needed for building. + +## Building from source + +This project is supposed to only run on Linux and Windows. + +### Windows + +
    +
  1. Install [Python](https://www.python.org/)
  2. +
  3. You have to clone the repo. (git clone http://kairoto.com:8080/git/Kairoto/GVM.git)
  4. +
  5. Install the needed dependencies. (pip install requests pyinstaller)
  6. +
  7. Use pyinstaller to build the app. (pyinstaller -D -F -n GVM.exe main.py)
  8. +
+Our pyinstaller command is recommended and tested. + +### Linux + +
    +
  1. Install [Python](https://www.python.org/) suiting your distro.
  2. +
  3. Install pip suiting your distro too. +
  4. You have to clone the repo. (git clone http://kairoto.com:8080/git/Kairoto/GVM.git)
  5. +
  6. Create a virtual environment by using python -m venv {ENV_NAME}.
  7. +
  8. Activate the virtual environment (python -m venv {ENV_NAME}).
  9. +
  10. Install the needed dependencies. (pip install requests pyinstaller)
  11. +
  12. Use pyinstaller to build the app. (pyinstaller -D -F -n GVM.exe main.py)
  13. +
+Our pyinstaller command is recommended and tested. \ No newline at end of file diff --git a/main.py b/main.py index b0e4ed8..c57436f 100644 --- a/main.py +++ b/main.py @@ -24,7 +24,7 @@ openSettings() def getAppDir() -> None : - app_path.set(fd.askdirectory(initialdir=pathlib.Path.home())) + app_path.set(fd.askdirectory(initialdir=pathlib.Path.home(),mustexist=True)) def quit() -> None : FRONTEND.quit()