Skip to content

Commit cfb7e43

Browse files
committed
docs: update README.md to enhance clarity and detail of the DevPC environment
1 parent fcfac24 commit cfb7e43

File tree

1 file changed

+65
-35
lines changed

1 file changed

+65
-35
lines changed

README.md

Lines changed: 65 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,92 @@
1-
# Docker images with software for develop C# and Typescript applications
1+
# DevPC - Containerized Development Environment
22

3-
This repository contains a Docker image with minimal Desktop installation and software for develop C# and Typescript applications.
3+
A fully-featured Docker image providing a complete desktop development environment for C# and TypeScript applications. This container includes a minimal desktop interface accessible via VNC, pre-configured with essential development tools.
44

5-
Includes packages:
5+
## Features
66

7-
- Fedora minimal,
8-
- OpenBox,
9-
- LXQt,
10-
- TigerVNC-Server,
11-
- Dotnet,
12-
- VS Code (with Typescript and C# extensions),
13-
- NodeJS (with global TypeScript, Npm-check-updates),
14-
- Git,
15-
- Falcon Browser.
7+
### Included Software
168

17-
The Image is automatically rebuilt every day, at midnight by GMT.
9+
- **Operating System**: Fedora Minimal
10+
- **Desktop Environment**: LXQt with OpenBox window manager
11+
- **Remote Access**: TigerVNC Server
12+
- **Development Tools**:
13+
- .NET SDK
14+
- Visual Studio Code (with C# and TypeScript extensions)
15+
- Node.js with TypeScript and npm-check-updates
16+
- Git version control
17+
- **Web Browser**: Falcon Browser
1818

19-
All other software you can install yourself.
19+
### Automatic Updates
2020

21-
![Docker LXQt Desktop access via TightVNC Client](https://raw.githubusercontent.com/LabEG/devpc/master/.pics/vnc_container_view.png)
21+
The image is automatically rebuilt daily at midnight GMT to ensure the latest security patches and software updates.
2222

23-
## GitHub
23+
> **Note**: You can install additional software as needed within the container.
2424
25-
The source code is located on the GitHub repository here:
25+
![Docker LXQt Desktop via VNC Client](https://raw.githubusercontent.com/LabEG/devpc/master/.pics/vnc_container_view.png)
2626

27-
[https://github.com/LabEG/devpc](https://github.com/LabEG/devpc)
27+
## Quick Start
2828

29-
## Try
29+
### Evaluation Mode
3030

31-
If you just want to try the features:
31+
To quickly test the environment without persistence:
3232

33-
```sh
33+
```bash
3434
docker run -it --rm -e password='YOUR_VNC_PASSWORD' -p 5901:5901 labeg/devpc
3535
```
3636

37-
## Use
37+
### Production Mode
3838

39-
If you want to use the container regularly:
39+
For regular use with automatic restart:
4040

41-
```sh
41+
```bash
4242
docker run -d --restart always -e password='YOUR_VNC_PASSWORD' -p 5901:5901 labeg/devpc
4343
```
4444

45-
## Parameters
45+
After starting the container, connect using any VNC client at `localhost:5901` with your specified password.
4646

47-
- `-e password='YOUR_VNC_PASSWORD'` - required, password for VNC connections.
48-
- `-e user_password='YOUR_USER_PASSWORD'` - optional, password for user *headless*. By default, will be used *password* variable.
49-
- `-e root_password='YOUR_ROOT_PASSWORD'` - optional, password for *root* user. By default, will be used *user_password* variable, if it is not specified then *password* variable.
50-
- `-e resolution='1920x1080'` - optional, resolution for virtual screen.
51-
- `--shm-size='64m'` - optional, extend if firefox browser is crashing.
47+
## Configuration
5248

53-
## FAQ
49+
### Environment Variables
5450

55-
- For change LXQT Theme open Menu > Preferences > Appearance > LXQt Theme and select nice to you theme, example Kde-Plasma.
56-
- For change OpenBox theme open Menu > Preferences > LXQt settings > Opebox Settings and select nice to you theme, example Clearlooks.
51+
| Variable | Required | Default | Description |
52+
|----------|----------|---------|-------------|
53+
| `password` | **Yes** | - | VNC connection password |
54+
| `user_password` | No | `password` | Password for the `headless` user |
55+
| `root_password` | No | `user_password` | Password for the `root` user |
56+
| `resolution` | No | `1280x1024` | Virtual screen resolution (e.g., `1920x1080`) |
5757

58-
## Build
58+
### Docker Options
5959

60-
```sh
60+
| Option | Purpose |
61+
|--------|---------|
62+
| `--shm-size='64m'` | Increase shared memory size if browsers crash |
63+
| `-p 5901:5901` | Expose VNC port |
64+
| `--restart always` | Auto-restart container on failure |
65+
66+
## Customization
67+
68+
### Changing the LXQt Theme
69+
70+
1. Open Menu → Preferences → Appearance → LXQt Theme
71+
2. Select your preferred theme (e.g., Kde-Plasma)
72+
73+
### Changing the OpenBox Theme
74+
75+
1. Open Menu → Preferences → LXQt Settings → OpenBox Settings
76+
2. Select your preferred theme (e.g., Clearlooks)
77+
78+
## Building from Source
79+
80+
To build the image locally:
81+
82+
```bash
6183
docker build -t labeg/devpc .
6284
```
85+
86+
## Repository
87+
88+
Source code: [https://github.com/LabEG/devpc](https://github.com/LabEG/devpc)
89+
90+
## License
91+
92+
See [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)