Git-Mirrors/veilidchat
1
0
Fork 0
mirror of https://gitlab.com/veilid/veilidchat.git synced 2025-09-26 19:11:01 -04:00
Code Issues Projects Releases Packages Wiki Activity

Updated CHANGELOG for v0.4.8 release

Browse source 
Also corrected some typos and linting in the new README.md
This commit is contained in:
TC Johnson 2025-06-03 13:00:38 -05:00
parent ee37d0dbba
commit 0ad7a1c0c1
No known key found for this signature in database
2 changed files with 47 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

9
CHANGELOG.md
View file

@ -1,4 +1,4 @@
## UNRELEASED ##
## v0.4.8 ##
- Fix reconciliation `advance()`
- Add `pool stats` command
@ -13,8 +13,11 @@
- Keyboard shortcut Ctrl+Alt+C - to change color scheme
- Keyboard shortcut Ctrl+Alt+B - to change theme brightness
- _Community Contributions_
- Refactor README.md for clarity and structure; enhance setup instructions and Flutter installation guidance @iKranium-Labs // @iKranium
## v0.4.7 ##
- *Community Contributions*
- _Community Contributions_
- Fix getting stuck on splash screen when veilid is already started @bmv437 / @bgrift
- Fix routing to home after initial account creation @bmv437 / @bgrift
- edit_account_form visual improvements @bmv437 / @bgrift
@ -79,7 +82,7 @@
- Support away/busy/free state
- Support away/busy/free messages
- Start of UI for auto-away feature (incomplete)
- *Community Contributions Shoutouts*
- _Community Contributions Shoutouts_
- @ethnh
- @sajattack
- @jasikpark

83
README.md
View file

@ -14,7 +14,7 @@ For more information about the Veilid network protocol and app development platf
VeilidChat is a Flutter application that interacts with the core Veilid library via Foreign Function Interface (FFI). While this is still in development, you **must** have a clone of the Veilid source checked out at `../veilid` relative to the working directory of this repository for the setup scripts to work. This is because the veilid-core source and build setup (including FFI components), which Veilidchat relies on, reside there.
```
```shell
your_workspace/
├── veilid/ <-- Veilid core repository
└── veilidchat/ <-- This repository
@ -22,34 +22,28 @@ your_workspace/
Refer to the main [Veilid repository](https://gitlab.com/veilid/veilid) for instructions.
<br>
### Flutter Installation
VeilidChat requires the Flutter SDK to build and run. Ensure Flutter is installed and available in your system's PATH. Choose one of the methods below:
**Option 1: Standard Installation (Recommended)**
Follow the official Flutter documentation for your operating system to install the SDK directly.
* **Official Flutter Install Guides:**
* [Windows](https://docs.flutter.dev/get-started/install/windows)
* [macOS](https://docs.flutter.dev/get-started/install/macos)
* [Linux](https://docs.flutter.dev/get-started/install/linux)
* [ChromeOS](https://docs.flutter.dev/get-started/install/chromeos)
* **Official Flutter Install Guides:**
* [Windows](https://docs.flutter.dev/get-started/install/windows)
* [macOS](https://docs.flutter.dev/get-started/install/macos)
* [Linux](https://docs.flutter.dev/get-started/install/linux)
* [ChromeOS](https://docs.flutter.dev/get-started/install/chromeos)
**Option 2: Installation via IDE Extension (Beginner-friendly for VS Code)**
Varioius IDEs may offer Flutter extensions that can assist with setup. For VS Code, the official Flutter extension can assist you through the SDK installation process.
Various IDEs may offer Flutter extensions that can assist with setup. For VS Code, the official Flutter extension can assist you through the SDK installation process.
1. Open VS Code.
2. Go to the Extensions view (`Ctrl+Shift+X` or `Cmd+Shift+X`).
3. Search for "Flutter" and install the official extension published by Dart Code.
4. Follow the prompts from the extension to install the Flutter SDK.
<br>
1. Open VS Code.
2. Go to the Extensions view (`Ctrl+Shift+X` or `Cmd+Shift+X`).
3. Search for "Flutter" and install the official extension published by Dart Code.
4. Follow the prompts from the extension to install the Flutter SDK.
**Running Veilid Core Setup Scripts:**
@ -59,18 +53,16 @@ In order to run the VeilidChat application, you will need the [Veilid repository
To run these setup scripts (from the [`veilidchat`](veilidchat) directory):
* For Linux Systems: Run [./dev-setup/setup_linux.sh](./dev-setup/setup_linux.sh) (Installs protoc and protoc-gen-dart)
* For Mac Systems: Run [./dev-setup/setup_macos.sh](./dev-setup/setup_macos.sh) (Installs protoc and protoc-gen-dart)
* For Windows Systems: Run [./dev-setup/setup_windows.bat](./dev-setup/setup_windows.bat) (**Requires manual installation of protoc beforehand**)
* For Linux Systems: Run [./dev-setup/setup_linux.sh](./dev-setup/setup_linux.sh) (Installs protoc and protoc-gen-dart)
* For Mac Systems: Run [./dev-setup/setup_macos.sh](./dev-setup/setup_macos.sh) (Installs protoc and protoc-gen-dart)
* For Windows Systems: Run [./dev-setup/setup_windows.bat](./dev-setup/setup_windows.bat) (**Requires manual installation of protoc beforehand**)
(check [`./dev-setup`](./dev-setup) for other platforms)
These scripts will check for required dependencies and set up the environment. For Windows users, please ensure you have manually downloaded and installed the protoc compiler (version 25.3 or higher is recommended) and added its directory to your system's PATH *before* running the setup script. The Windows script will verify its presence.
**Note on Python Environments:** The dev-setup scripts in the main Veilid repository may utilize Python virtual environments (`venv`) for managing dependencies needed for build processes (like FFI generation scripts). If your system uses a system-managed Python environment or you encounter permission issues, ensure you follow any instructions provided by the setup scripts regarding environment activation or configuration.
### Verifying Installation
## Verifying Installation
After installing Flutter and running the ./dev-setup scripts, verify that everything is set up correctly. Open a terminal and run the following command from anywhere accessible by your PATH:
@ -78,9 +70,9 @@ After installing Flutter and running the ./dev-setup scripts, verify that everyt
This command checks your environment and displays a report of the status of your Flutter installation and connected devices. It will list any missing dependencies or configuration issues for common development platforms (Android, iOS, Web, Desktop).
**Example Output (Partial):**
```
```shell
$ flutter doctor
Doctor summary (to see all details, run flutter doctor -v):
@ -98,78 +90,85 @@ Doctor summary (to see all details, run flutter doctor -v):
Address any issues reported by `flutter doctor` before proceeding.
```
<br>
## Building and Launching
VeilidChat is a Flutter application and can be built and launched on various platforms supported by Flutter, provided you have the necessary SDKs and devices/emulators configured as verified by `flutter doctor`.
1. **Ensure Flutter dependencies are installed**:
1. **Ensure Flutter dependencies are installed**:
From the `veilidchat` directory, run:
```bash
flutter pub get
```
2. **List available devices**:
2. **List available devices**:
To see which devices (simulators, emulators, connected physical devices, desktop targets, web browsers) are available to run the application on, use the command:
```bash
flutter devices
```
3. **Run on a specific device**:
3. **Run on a specific device**:
Use the `flutter run` command followed by the `-d` flag and the device ID from the `flutter devices` list.
* **Example (Android emulator/device):**
* **Example (Android emulator/device):**
Assuming an Android device ID like `emulator-5554`:
```bash
flutter run -d emulator-5554
```
If only one device is connected, you can often omit the `-d` flag.
* **Example (iOS simulator/device):**
* **Example (iOS simulator/device):**
Assuming an iOS simulator ID like `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`:
```bash
flutter run -d xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` (replace with actual ID)
```
Or, to target the default iOS simulator:
```bash
flutter run -d simulator
```
* **Example (Linux Desktop):**
* **Example (Linux Desktop):**
```bash
flutter run -d linux
```
* **Example (macOS Desktop):**
* **Example (macOS Desktop):**
```bash
flutter run -d macos
```
* **Example (Windows Desktop):**
* **Example (Windows Desktop):**
```bash
flutter run -d windows
```
* **Example (Web):**
* **Example (Web):**
```bash
flutter run -d web # Or a specific browser like 'chrome' or 'firefox' if listed by `flutter devices`
```
This will typically launch the application in your selected web browser.
<br>
This will typically launch the application in your selected web browser.
## Updating the WASM Binary
### To update the WASM binary
[from the `veilid-wasm` package located in [`../veilid/veilid-wasm`](../veilid/veilid-wasm)]
[from the `veilid-wasm` package located in [`../veilid/veilid-wasm`](../veilid/veilid-wasm)]
From the VeilidChat repository working directory ([`./veilidchat`](./veilidchat)), run the appropriate script:
* Debug WASM: [`./dev-setup/wasm_update.sh`](./dev-setup/wasm_update.sh)
* Release WASM: [`./dev-setup/wasm_update.sh release`](./dev-setup/wasm_update.sh)
<br>
* Debug WASM: [`./dev-setup/wasm_update.sh`](./dev-setup/wasm_update.sh)
* Release WASM: [`./dev-setup/wasm_update.sh release`](./dev-setup/wasm_update.sh)
Refer to the official [Flutter documentation](https://docs.flutter.dev/) for more detailed information on building and deployment with Flutter.