search

Affirmatech / MeshSense

MeshSense directly connects to your Meshtastic node via Bluetooth or WiFi and continuously provides information to assess the health of your mesh network.
https://affirmatech.com/meshsense
GNU General Public License v3.0
47 stars 6 forks source link

Minor Project Cleanup and Documentation Pass #6

Closed nbgibson closed 2 months ago

nbgibson commented 2 months ago

Nothing too major here. I removed the .vscode dir from tracking along with the prettier conf file (neither are needed in a distributed code base). In addition to this, I replicated the contents of the project's homepage in a ReadMe file as that presents a good bit better than a lengthy license file.

I would strongly suggest attaching the 1.0.13 binaries from the website to the repo in the releases section as well.

Soltares commented 2 months ago

Awesome! Thank you for doing this -- much appreciated!

nbgibson commented 2 months ago

No problem. If you'll detail how you're compiling the binaries for the app I can see about setting up some CI pipelines to do it automatically.

Soltares commented 2 months ago

Interesting, thank you! I'm not sure how that works with signing the Windows and Mac binaries as I am still getting acquainted with GitHub. I'll eventually update the Readme, but essentially the steps on each platform are running update.mjs to update dependencies and then build.mjs at the project root. I then run publish.mjs to upload the artifacts using a DEPLOY_LOCATION environment variable.

For Mac, it references env variables from a top-level .env file for signing. Windows seems to automatically pull what it needs for signing from our build system.

CI = false
APPLE_ID=
APPLE_ID_PASS=
APPLE_APP_SPECIFIC_PASSWORD=
APPLE_TEAM_ID=