Skip to content

Commit

Permalink
Merge pull request #1113 from cogentcore/app-docs
Browse files Browse the repository at this point in the history
add docs for Body name, app icon, and deploying a web app
  • Loading branch information
rcoreilly authored Aug 4, 2024
2 parents 8730313 + 641442e commit bbf00b5
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/content/1-basics/1-apps.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The first call in every Cogent Core app is [[core.NewBody]]. This creates and returns a new [[core.Body]], which is a container in which app content is placed.
The first call in every Cogent Core app is [[core.NewBody]]. This creates and returns a new [[core.Body]], which is a container in which app content is placed. This takes an optional name, which is used for the title of the app/window/tab.

After calling [[core.NewBody]], you add content to the [[core.Body]] that was returned, which is typically given the local variable name `b` for body.

Expand Down
4 changes: 4 additions & 0 deletions docs/content/2-setup/building.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ The `core` command line tool provides four main build commands, as documented be

You can build for mobile and web platforms by adding the platform name after the command. For example, you can run `core run android` to build and run an app on an Android device, `core build ios` to build an app for an iOS device, and `core run web` to serve an app on the web.

Note: `core run web` is mainly used for serving an app locally; to deploy an app on the web, you can use `core build web` and a static site host (here is an [example](https://github.com/cogentcore/cogentcore.github.io/blob/main/.github/workflows/core.yml) using GitHub Pages).

If there is an `icon.svg` file in the current directory, it will be used as the app icon on all platforms.

For development on Android, you need to install [Android Studio](https://developer.android.com/studio), and for development on iOS, you need to install [XCode](https://apps.apple.com/us/app/xcode/id497799835?mt=12). For Android development, if you run into any errors with the Android NDK, you should ensure that it is [installed](https://developer.android.com/studio/projects/install-ndk#default-version). You may also need to add the Android tools [to your PATH](https://stackoverflow.com/a/29083170).

You can see the [advanced building page](../advanced/building) for more information if you need it.

0 comments on commit bbf00b5

Please sign in to comment.