Merge pull request 'readme-run' (#249) from readme-run into trunk
continuous-integration/drone/push Build is pending
Details
continuous-integration/drone/push Build is pending
Details
Reviewed-on: #249
This commit is contained in:
commit
f030e8b573
17
README.md
17
README.md
|
@ -28,7 +28,7 @@ Cwtch processes the following environment variables:
|
||||||
First you will need a valid [flutter sdk installation](https://flutter.dev/docs/get-started/install).
|
First you will need a valid [flutter sdk installation](https://flutter.dev/docs/get-started/install).
|
||||||
You will probably want to disable Analytics on the Flutter Tool: `flutter config --no-analytics`
|
You will probably want to disable Analytics on the Flutter Tool: `flutter config --no-analytics`
|
||||||
|
|
||||||
This project uses the flutter `dev` channel, which you will need to switch to: `flutter channel dev; flutter upgrade`.
|
This project uses the flutter `stable` channel
|
||||||
|
|
||||||
Once flutter is set up, run `flutter pub get` from this project folder to fetch dependencies.
|
Once flutter is set up, run `flutter pub get` from this project folder to fetch dependencies.
|
||||||
|
|
||||||
|
@ -42,17 +42,20 @@ To build a release version and load normal profiles, use `build-release.sh X` in
|
||||||
- set `LD_LIBRARY_PATH="$PWD/linux"`
|
- set `LD_LIBRARY_PATH="$PWD/linux"`
|
||||||
- copy a `tor` binary to `linux/` or run `fetch-tor.sh` to download one
|
- copy a `tor` binary to `linux/` or run `fetch-tor.sh` to download one
|
||||||
- run `flutter config --enable-linux-desktop` if you've never done so before
|
- run `flutter config --enable-linux-desktop` if you've never done so before
|
||||||
- optional: launch cwtch-ui directly by running `flutter run -d linux`
|
- optional: launch cwtch-ui debug build by running `flutter run -d linux`
|
||||||
- to build cwtch-ui, run `flutter build linux`
|
- to build cwtch-ui, run `flutter build linux`
|
||||||
- optional: launch cwtch-ui build with `env LD_LIBRARY_PATH=linux ./build/linux/x64/release/bundle/cwtch`
|
- optional: launch cwtch-ui release build with `env LD_LIBRARY_PATH=linux ./build/linux/x64/release/bundle/cwtch`
|
||||||
- to package the build, run `linux/package-release.sh`
|
- to package the build, run `linux/package-release.sh`
|
||||||
|
|
||||||
### Building on Windows (for Windows)
|
### Building on Windows (for Windows)
|
||||||
|
|
||||||
- copy `libCwtch.dll` to `windows/`, or run `fetch-libcwtch-go.ps1` to download it
|
- copy `libCwtch.dll` to `windows/`, or run `fetch-libcwtch-go.ps1` to download it
|
||||||
- run `fetch-tor-win.ps1` to fetch Tor for windows
|
- run `fetch-tor-win.ps1` to fetch Tor for windows
|
||||||
- optional: launch cwtch-ui directly by running `flutter run -d windows`
|
- optional: launch cwtch-ui debug build by running `flutter run -d windows`
|
||||||
- to build cwtch-ui, run `flutter build windows`
|
- to build cwtch-ui, run `flutter build windows`
|
||||||
|
- optional: to run the release build:
|
||||||
|
- `cp windows/libCwtch.dll .`
|
||||||
|
- `./build/windows/runner/Release/cwtch.exe`
|
||||||
|
|
||||||
### Building on Linux/Windows (for Android)
|
### Building on Linux/Windows (for Android)
|
||||||
|
|
||||||
|
@ -65,10 +68,8 @@ To build a release version and load normal profiles, use `build-release.sh X` in
|
||||||
- copy `libCwtch.dylib` into the root folder, or run `fetch-libcwtch-go-macos.sh` to download it
|
- copy `libCwtch.dylib` into the root folder, or run `fetch-libcwtch-go-macos.sh` to download it
|
||||||
- run `fetch-tor-macos.sh` to fetch Tor or Download and install Tor Browser and `cp -r /Applications/Tor\ Browser.app/Contents/MacOS/Tor ./macos/`
|
- run `fetch-tor-macos.sh` to fetch Tor or Download and install Tor Browser and `cp -r /Applications/Tor\ Browser.app/Contents/MacOS/Tor ./macos/`
|
||||||
- `flutter build macos`
|
- `flutter build macos`
|
||||||
- optional: launch cwtch-ui build with `./build/linux/x64/release/bundle/cwtch`
|
- optional: launch cwtch-ui release build with `./build/macos/Build/Products/Release/Cwtch.app/Contents/MacOS/Cwtch`
|
||||||
- `./macos/package-release.sh`
|
- To package the UI: `./macos/package-release.sh`, which results in a Cwtch.dmg that has libCwtch.dylib and tor in it as well and can be installed into Applications
|
||||||
|
|
||||||
results in a Cwtch.dmg that has libCwtch.dylib and tor in it as well and can be installed into Applications
|
|
||||||
|
|
||||||
### Known Platform Issues
|
### Known Platform Issues
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue