Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
emcek committed Jan 22, 2025
1 parent c47d849 commit fae4cd4
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 32 deletions.
26 changes: 7 additions & 19 deletions docs/install.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Installation
There are two ways of install DCSpy: single file download (basic / new way) or via Python package manager (advanced / old way). Both have advantages and disadvantages. For new users it is recommended to use first one, current users can stick to old way or switch to new way. Both will be supported.

## Single file download (new way)
## Single file download (basic way)
* Advantage: Simple download and you are ready to go
* Disadvantage: Windows Defender can block download/execution

Expand All @@ -16,33 +16,21 @@ There are two ways of install DCSpy: single file download (basic / new way) or v

Due to how Python application can be pack into executable file (using PyInstaller/Nuitka), sometimes Windows Defender can recognize it as a virus. See more details [here](defender.md)

## via pip (old way)
## via uv (advanced way)
* Advantage: Better control, simple update process, no Defender hassle
* Disadvantage: Python interpreter is needed, more steps, more complicated process
* Disadvantage: Python interpreter and/or uv tool is needed, more steps, more complicated process

1. Install [Logitech Gaming Software 9.04.49](https://support.logitech.com/software/lgs)
2. Download [Python 3.13](https://www.python.org/downloads/) but 3.9+ should be fine, please choose **Windows x86-64** version, file should be `python-3.13.0-amd64.exe`.
3. During Python installation please select
* Optional Features:
* pip
* py launcher
* Advanced Options:
* Associate files with Python (requires the py launcher)
* Add Python to environment variables
* Customize install location: **C:\Python313** or **C:\Python**
4. DCS-BIOS
2. Install [uv](https://github.com/astral-sh/uv)
3. DCS-BIOS
* You can skip for now and install DCS-BIOS directly from DCSpy (button Check DCS-BIOS, see [Configuration](usage.md#configuration)).
It checks if new version exists, download, and unpack DCS-BIOS to `Save Games` folder and check `Export.lua` file.
* Or follow manual installation [DCS-BIOS wiki page](https://github.com/DCS-Skunkworks/DCSFlightpanels/wiki/Installation)
5. Package is available on [PyPI](https://pypi.org/project/dcspy/), open Windows Command Prompt (cmd.exe) and type:
4. Package is available on [PyPI](https://pypi.org/project/dcspy/), open Windows Command Prompt (cmd.exe) and type:
```shell script
pip install dcspy
uv tool install -p 3.13 dcspy
```

or download manually wheel file from [releases](https://github.com/emcek/dcspy/releases/latest):
```shell script
pip install dcspy-3.6.3-py3-none-any.whl
```

**Note:** If you got `pip is not recognized as an internal or external command, operable program or batch file.` error, see [FAQ](faq.md)

Expand Down
10 changes: 5 additions & 5 deletions docs/upgrade.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# DCSpy
## Single file download (new way)
## Single file download (basic/recommended way)
Just download latest file from [Releases](https://github.com/emcek/dcspy/releases/latest)

## via pip (old way)
## via uv (advanced way)
To upgrade DCSpy to the latest version, open Command Prompt and type:
```shell script
pip install -U dcspy
uv tool update dcspy
```
**Note:** If you upgrade DCSpy from 1.5.1 or older you can remove Logitech LCD SDK from `C:\Program Files\Logitech Gaming Software\LCDSDK_8.57.148`

## Switch from OldWay to NewWay
## Switch from advanced to basic
1. Remove dcspy, open Command Prompt and type:
```shell script
pip uninstall -y dcspy
uv tool uninstall dcspy
```
2. Follow installation [procedure](install.md#single-file-download-new-way).

Expand Down
12 changes: 4 additions & 8 deletions docs/usage.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,15 @@
# Starting
## Single file download (new way)
## Single file download (basic way)
1. Run Logitech Gaming Software (it allows accessing LCD)
2. Double click at downloaded file.
3. Click `Start`
4. LCD should update with dcspy basic info, waiting to connect to DCS
5. Run DCS and start any mission.

## via pip (old way)
## via uv (advanced way)
1. Run Logitech Gaming Software (it allows accessing LCD)
2. You can check with `pip uninstall dcspy` (**NOTE!** answer **No** to question) where dcspy was installed. Usually pip should install dcspy into your python directory: i.e.:
* `d:\projects\venvs\dcspy\lib\site-packages\dcspy-3.0.0.dist-info\*`
* `d:\projects\venvs\dcspy\lib\site-packages\dcspy\*`
* `d:\projects\venvs\dcspy\scripts\dcspy.exe`
* `d:\projects\venvs\dcspy\scripts\dcspy_cli.exe`
3. You can drag and drop `dcspy.exe` or `dcspy_cli.exe` to desktop and make shortcut (with custom icon, you can find icon in installation directory i.e. `d:\projects\venvs\dcspy\lib\site-packages\dcspy\img\dcspy.ico`).
2. You can check with `uv` install tool inside user directory like `C:\Users\<username>\AppData\Local\uv\tools\dcspy\Scripts`
3. You can drag and drop `dcspy.exe` or `dcspy_cli.exe` to desktop and make shortcut (with custom icon, you can find icon in installation directory i.e. `C:\Users\mplic\AppData\Local\uv\tools\dcspy\Lib\site-packages\dcspy\img`).
* `dcspy.exe` - with open directly GUI window
* `dcspy_cli.exe` - additionally start console window (with logs)
4. Double-click on dcspy icon or type `dcspy.exe`\`dcspy_cli.exe` from Command Prompt
Expand Down

0 comments on commit fae4cd4

Please sign in to comment.