Skip to content

Commit

Permalink
docs: split README into offline and online configuration docs
Browse files Browse the repository at this point in the history
    - Added recommendation to use Offline Mode in the online.md document with an explanation of benefits.
    - Clarified  behavior in offline.md, indicating it is intended for new installations and online mode.
    - Provided detailed steps for configuring Offline Mode and Online Mode in separate documentation files.
    - Linked mode-specific documentation from the main README for easier navigation.
  • Loading branch information
jiongxuan committed Oct 7, 2024
1 parent a95c845 commit 73cc042
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,14 @@ npm start

Packaging the app is done via [electron-builder](https://github.com/electron-userland/electron-builder). To start packaging run `npm run dist`. If you want to add new platforms and experiment with the build options the easiest way to do so is manipulating the `build` property in the [package.json](https://github.com/johannesjo/super-productivity/blob/develop/package.json), but you can also use the [command line interface of electron builder](https://www.electron.build/cli).

### Building for Android

*This feature was added on October 7, 2024. See [Pull Request #57](https://github.com/johannesjo/super-productivity-android/pull/57).*

To build the Android version of Super Productivity, please refer to the [Android Offline Mode Documentation](./android/offline.md).

Ensure you have followed the steps outlined in the offline documentation to set up and configure the Android build environment properly.

## Run as Docker Container

```bash
Expand Down
2 changes: 1 addition & 1 deletion android
Submodule android updated 3 files
+35 −64 README.md
+80 −0 README_OFFLINE.md
+93 −0 README_ONLINE.md

0 comments on commit 73cc042

Please sign in to comment.