added file descriptions for src folder

This commit is contained in:
k4yt3x 2020-06-09 08:53:17 -04:00
parent da4bfe9827
commit 29a776d049

21
src/README.md Normal file
View File

@ -0,0 +1,21 @@
# Directory Listing
- [**images**](images): image assets such as executable icons
- [**locale**](locale): language locale files (.po, .mo)
- [**pyinstaller**](pyinstaller): PyInstaller-specific files
- [**wrappers**](wrappers): binary Python wrappers/bindings
- [**bilogger.py**](bilogger.py): bidirectional logger
- [**build.ps1**](build.ps1): release building script
- [**exceptions.py**](exceptions.py): custom exceptions
- [**image_cleaner.py**](image_cleaner.py): upscaled images cleaner
- [**progress_monitor.py**](progress_monitor.py): upscaling progress monitor
- [**requirements.txt**](requirements.txt): Python requirements for pip
- [**upscaler.py**](upscaler.py): main upscaler class
- [**video2x.pot**](video2x.pot): project i18n POT translation file
- [**video2x.py**](video2x.py): command line interface
- [**video2x.yaml**](video2x.yaml): configuration file
- [**video2x_gui.py**](video2x_gui.py): graphical user interface
- [**video2x_gui.pyproject**](video2x_gui.pyproject): QtCreator project file
- [**video2x_gui.ui**](video2x_gui.ui): GUI UI file (defines GUI layout)
- [**video2x_setup.py**](video2x_setup.py): automatic setup script for Windows
- [**video2x_setup_ubuntu.sh**](video2x_setup_ubuntu.sh): automatic setup script for Ubuntu