Skip to content

Commit 2494b91

Browse files
Stefan ErnstStefan Ernst
authored andcommitted
Update documentation: new logo and rename vx client to ws
- Replace logo with windshift-3.svg in README - Rename all vx client references to ws in BUILD.md
1 parent 287b288 commit 2494b91

2 files changed

Lines changed: 21 additions & 21 deletions

File tree

BUILD.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This document explains how to build Windshift for multiple platforms.
66

77
### Build Everything (Recommended)
88
```bash
9-
# Build both server and vx client for all platforms
9+
# Build both server and ws client for all platforms
1010
./build-all.sh
1111

1212
# Clean and build everything
@@ -15,7 +15,7 @@ This document explains how to build Windshift for multiple platforms.
1515
# Build only the server
1616
./build-all.sh --server-only
1717

18-
# Build only the vx client
18+
# Build only the ws client
1919
./build-all.sh --client-only
2020

2121
# Get help
@@ -33,9 +33,9 @@ cd ..
3333
# Build server (current platform)
3434
go build -o windshift main.go
3535

36-
# Build vx client (current platform)
37-
cd cmd/vx
38-
go build -o vx
36+
# Build ws client (current platform)
37+
cd cmd/ws
38+
go build -o ws
3939
cd ../..
4040
```
4141

@@ -52,20 +52,20 @@ dist/
5252
│ ├── windshift-darwin-amd64
5353
│ └── windshift-darwin-arm64
5454
└── client/
55-
├── vx-linux-amd64
56-
├── vx-linux-arm64
57-
├── vx-windows-amd64.exe
58-
├── vx-darwin-amd64
59-
└── vx-darwin-arm64
55+
├── ws-linux-amd64
56+
├── ws-linux-arm64
57+
├── ws-windows-amd64.exe
58+
├── ws-darwin-amd64
59+
└── ws-darwin-arm64
6060
```
6161

6262
## Supported Platforms
6363

64-
| Platform | Server | VX Client |
64+
| Platform | Server | WS Client |
6565
|----------|--------|-----------|
6666
| Linux (x64) |||
6767
| Linux (ARM64) |||
68-
| Windows (x64) |||
68+
| Windows (x64) |||
6969
| macOS (Intel) |||
7070
| macOS (Apple Silicon) |||
7171

@@ -77,9 +77,9 @@ Go makes cross-compilation easy. You can build for any platform from any platfor
7777
# Build server for Linux from macOS/Windows
7878
GOOS=linux GOARCH=amd64 go build -o windshift-linux main.go
7979

80-
# Build vx client for Windows from Linux/macOS
81-
cd cmd/vx
82-
GOOS=windows GOARCH=amd64 go build -o vx-windows.exe
80+
# Build ws client for Windows from Linux/macOS
81+
cd cmd/ws
82+
GOOS=windows GOARCH=amd64 go build -o ws-windows.exe
8383
cd ../..
8484

8585
# Build for ARM64 (Apple Silicon, ARM Linux)
@@ -94,7 +94,7 @@ GOOS=linux GOARCH=arm64 go build -o windshift-linux-arm64 main.go
9494
- **Node.js 18+** - Frontend build
9595
- **npm** - Package management
9696

97-
### For VX Client Only
97+
### For WS Client Only
9898
- **Go 1.21+** - Client compilation only
9999

100100
## Usage Examples
@@ -104,21 +104,21 @@ GOOS=linux GOARCH=arm64 go build -o windshift-linux-arm64 main.go
104104
# Extract and run
105105
tar -xzf windshift-linux-amd64.tar.gz
106106
./dist/server/windshift-linux-amd64 &
107-
./dist/client/vx-linux-amd64 workspace list
107+
./dist/client/ws-linux-amd64 workspace list
108108
```
109109

110110
### Windows
111111
```bash
112-
# Extract and run
112+
# Extract and run
113113
dist\server\windshift-windows-amd64.exe
114-
dist\client\vx-windows-amd64.exe workspace list
114+
dist\client\ws-windows-amd64.exe workspace list
115115
```
116116

117117
### macOS
118118
```bash
119119
# Extract and run
120120
./dist/server/windshift-darwin-arm64 &
121-
./dist/client/vx-darwin-arm64 workspace list
121+
./dist/client/ws-darwin-arm64 workspace list
122122
```
123123

124124
## Build Optimization

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<p align="center">
2-
<img src="frontend/public/cmicon-2.svg" alt="Windshift" width="120" height="120">
2+
<img src="frontend/public/windshift-3.svg" alt="Windshift" width="120" height="120">
33
</p>
44

55
<h1 align="center">Windshift</h1>

0 commit comments

Comments
 (0)