Update README with one-line installation commands
- Add prominent Quick Installation section with curl commands - Include both SSH and HTTPS installation options - Document post-installation usage options - Add uninstall instructions - Improve visibility of convenient installation methods
This commit is contained in:
39
README.md
39
README.md
@@ -28,6 +28,28 @@ A modern Python-based RDP client with GUI interface that replaces the zenity-bas
|
||||
|
||||
## Installation
|
||||
|
||||
### Quick Installation (Recommended)
|
||||
|
||||
**One-line installation** that handles everything automatically:
|
||||
|
||||
```bash
|
||||
# For users with SSH access to the repository:
|
||||
curl -fsSL https://gitea.egonetix.de/root/rdp_client/raw/branch/main/install_rdp_client_complete.sh | bash
|
||||
|
||||
# For users without SSH access (HTTPS version):
|
||||
curl -fsSL https://gitea.egonetix.de/root/rdp_client/raw/branch/main/install_rdp_client_https.sh | bash
|
||||
```
|
||||
|
||||
The installer will:
|
||||
- Auto-detect your Linux distribution (Ubuntu, Fedora, Arch, openSUSE, etc.)
|
||||
- Install all system dependencies (freerdp, python3, git, etc.)
|
||||
- Clone the repository to `~/rdp-client`
|
||||
- Set up Python virtual environment with dependencies
|
||||
- Create desktop entry and launcher script
|
||||
- Make the client available as `rdp-client` command
|
||||
|
||||
### Manual Installation
|
||||
|
||||
1. Clone this repository:
|
||||
```bash
|
||||
git clone git@gitea.egonetix.de:root/rdp_client.git
|
||||
@@ -50,8 +72,25 @@ pip install cryptography
|
||||
chmod +x rdp_client.py
|
||||
```
|
||||
|
||||
### Uninstall
|
||||
|
||||
If you used the quick installer, you can uninstall with:
|
||||
```bash
|
||||
~/rdp-client/install_rdp_client_complete.sh --uninstall
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
### After Installation
|
||||
|
||||
Once installed, you can run the RDP client in several ways:
|
||||
|
||||
- **From command line**: `rdp-client`
|
||||
- **From applications menu**: Search for "RDP Client"
|
||||
- **Direct execution**: `~/rdp-client/.venv/bin/python ~/rdp-client/rdp_client.py`
|
||||
|
||||
Configuration files are automatically created in `~/.config/rdp-client/`.
|
||||
|
||||
### Running the Application
|
||||
|
||||
```bash
|
||||
|
||||
Reference in New Issue
Block a user