Skip to content

Commit

Permalink
Update Latest Code section of README
Browse files Browse the repository at this point in the history
  • Loading branch information
atticuscornett committed Jul 18, 2024
1 parent fa0dc8c commit d1fed8f
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,15 @@ Some beta version builds will be added to GitHub releases.

## Latest Code (Unstable, Not Recommended)
By downloading the repository files, you can build the latest code on your machine using CapacitorJS (for the Android version) or using Electron in the `electron` folder (for all desktop versions).
Node and npm are required to build the latest code.

To run Electron version:
1. Download node libraries with `npm install`
2. Run the app with `npm start`

To run Android version:
1. Sync the project with `npx cap sync`
2. Build and run the app in Android Studio.

# <a name="goals"></a>Project Goals
### Minimum Bloat
Expand Down
2 changes: 2 additions & 0 deletions android/.idea/misc.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit d1fed8f

Please sign in to comment.