readme: clarify build instructions #167

mal · 2021-09-02T04:13:23Z

mal commented

2021-09-02 04:13:23 +00:00

I had to read the CI stuff and flutter docs to figure out what I was doing wrong >.<

I tried to keep it simple but clarify run vs build where I knew or could guess how, but I can't look at it fresh.

I had to read the CI stuff and flutter docs to figure out what I was doing wrong >.< I tried to keep it simple but clarify run vs build where I knew or could guess how, but I can't look at it fresh.

dan was assigned by sarah

2021-09-07 20:41:29 +00:00

sarah added this to the Cwtch Beta 1.3 project 2021-09-07 20:42:05 +00:00

dan requested changes 2021-09-07 23:52:58 +00:00

README.md Outdated

					
				@ -31,2 +29,4 @@

				You will probably want to disable Analytics on the Flutter Tool: `flutter config --no-analytics`

				If the build fails, you may need to switch to a beta or newer release channel with

				`flutter channel beta; flutter upgrade`.

dan commented

2021-09-07 23:44:30 +00:00

ah yeah we're on the dev channel :)

mal commented

2021-09-08 02:51:40 +00:00

Should I suggest dev, or is "beta or newer" sufficient?

Should I suggest `dev`, or is "beta or newer" sufficient?

mal commented

2021-09-08 02:53:38 +00:00

Interestingly, I originally had a :thumbsup: emoji at the beginning of that comment, and gitea reliably HTTP 500'd. Removing it worked. Seems to happen with other emoji too.
ETA: It only seems to happen with the real emoji in the text field - a literal e.g. :thumbsup: seems to be successfully stored as-is and replaced on output 🤷
ETA more: Possibly a MySQL db/table using utf8 instead of utf8mb4?

Interestingly, I originally had a `:thumbsup:` emoji at the beginning of that comment, and gitea reliably HTTP 500'd. Removing it worked. Seems to happen with other emoji too. ETA: It only seems to happen with the real emoji in the text field - a literal e.g. `:thumbsup:` seems to be successfully stored as-is and replaced on output :shrug: ETA more: Possibly a MySQL db/table using utf8 instead of utf8mb4?

dan commented

2021-09-08 23:29:01 +00:00

this gitea instance has been through some upgrades and migrations. not entirely shocked there may be a schema problem in some table

but yeah reccomend dev for now as that's what we're sticking with

this gitea instance has been through some upgrades and migrations. not entirely shocked there may be a schema problem in some table but yeah reccomend dev for now as that's what we're sticking with

mal marked this conversation as resolved

README.md Outdated

					
				@ -33,0 +33,4 @@

				Once flutter is set up, run `flutter pub get` from this project folder to fetch dependencies.

				If you are building a release version, you'll need to add something like the following to the `flutter build` commands below:

dan commented

2021-09-07 23:46:36 +00:00

might want to explain what a release build is (why it's different) which is building a local "dev" copy like this normally we use $CWTCH_HOME/dev/ for the profiles and the only way to make it use the $CWTCH_HOME is "release build" with these variables defined

mal marked this conversation as resolved

README.md Outdated

					
				@ -38,0 +43,4 @@

				- copy `libCwtch-go.so` to `linux/`, or run `fetch-libcwtch-go.sh` to download it

				- set `LD_LIBRARY_PATH="$PWD/linux"`

				- copy a `tor` binary to `linux/` or run `fetch-tor.sh` to download one

				- set `PATH="$PATH:$PWD/linux`

dan commented

2021-09-07 23:51:46 +00:00

shoot was this neccesary? i guess i have tor installed on my system and assumed the pathing grabbed it from here for those who didn't. In this case it might be better to add another if ( path check ) { } to the tor bundled detection code in lib/cwtch/ffi.dart rather than having ppl set the path?

shoot was this neccesary? i guess i have tor installed on my system and assumed the pathing grabbed it from here for those who didn't. In this case it might be better to add another `if ( path check ) { }` to the tor bundled detection code in lib/cwtch/ffi.dart rather than having ppl set the path?

mal commented

2021-09-08 02:45:51 +00:00

I kept it because it was there before, but cwtch does find linux/tor without changing $PATH as long as $PWD is the project root. Will remove.
bc24c7f3c7/lib/cwtch/ffi.dart (L102)

I kept it because it was there before, but cwtch does find linux/tor without changing $PATH as long as $PWD is the project root. Will remove. https://git.openprivacy.ca/cwtch.im/cwtch-ui/src/commit/bc24c7f3c7f4cc5ca8694204951dedf55714ad68/lib/cwtch/ffi.dart#L102

mal marked this conversation as resolved

README.md Outdated

					
				@ -38,0 +44,4 @@

				- set `LD_LIBRARY_PATH="$PWD/linux"`

				- copy a `tor` binary to `linux/` or run `fetch-tor.sh` to download one

				- set `PATH="$PATH:$PWD/linux`

				- run `flutter config --enable-linux-desktop` if you've never done so before

dan commented

2021-09-07 23:52:31 +00:00

the docs weren't super clear here, I thought this was just an operation that had to be done once to the repo project to auto gen files under linux/ and not per checkout for each dev

the docs weren't super clear here, I thought this was just an operation that had to be done once to the repo project to auto gen files under `linux/` and not per checkout for each dev

mal commented

2021-09-08 02:34:52 +00:00

Until I did the --enable, flutter run gave "No devices found with name or id matching 'linux'" - so it seems to be a global flutter config option. I used archlinux AUR flutter/flutter-beta packages though, so it's possible those have different defaults.

Until I did the --enable, `flutter run` gave "No devices found with name or id matching 'linux'" - so it seems to be a global flutter config option. I used archlinux AUR `flutter`/`flutter-beta` packages though, so it's possible those have different defaults.

dan commented

2021-09-08 23:29:26 +00:00

eeeesh, ah well, cool!

mal marked this conversation as resolved

dan commented

2021-09-07 23:54:23 +00:00

sorry it's taken a week to get to these, it's unearthed that our Drone CI setup can't build other repo forks so even tho this is just a text update PR and your other one is a simple shell change, I'm not diving into fixing that as a prerequisite. -_-;