Skip to content

Commit

Permalink
docs: AlphaTab tutorial (#87)
Browse files Browse the repository at this point in the history
  • Loading branch information
Danielku15 authored May 14, 2024
1 parent 32563c3 commit 2024f53
Show file tree
Hide file tree
Showing 31 changed files with 3,046 additions and 24 deletions.
8 changes: 7 additions & 1 deletion docs/getting-started/installation-android.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<Tabs
defaultValue="js"
defaultValue="gradle-kotlin"
values={[
{ label: 'Gradle (Kotlin)', value: 'gradle-kotlin', },
{ label: 'Gradle (Groovy)', value: 'gradle-groovy', },
Expand Down Expand Up @@ -86,6 +86,12 @@ dependencies {

After adding alphaTab as a dependency to your project, you can add the alphaTab control `alphaTab.AlphaTabView` to any layout.

:::info

Important: We currently only ship a classical "view" based control. If you have interest in a Jetpack Compose control, vote for [this issue](https://github.com/CoderLine/alphaTab/issues/1475) on our roadmap or try to [wrap the classical control](https://developer.android.com/develop/ui/compose/libraries).

:::

```xml
<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout
Expand Down
2 changes: 1 addition & 1 deletion docs/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ The Kotlin for Android version of alphaTab comes as Maven package on Maven Centr
* Package Name: `alphaTab-android`


:::warn
:::warning
The Kotlin for Android version is still fairly new and there might be still some problems. We rely on your feedback to continuously improve this target.
:::

Expand Down
5 changes: 3 additions & 2 deletions docs/tutorial-android/conclusion.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ title: Conclusion

This was it about the tutorial on how to learn using alphaTab for your projects.
Next step for you would be to head over to the [reference docs](/docs/reference/settings)
and learn about the full feature set of alphaTab and what additional features you might want to integrate into your app.
and learn about the full feature set of alphaTab and what additional features you might want to integrate into your app.

<img src="/img/tutorial-android/result.png" height="400" />
<img src="/img/tutorial-android/conclusion-1.png" width="400" />
<img src="/img/tutorial-android/conclusion-2.png" width="400" />

It is up to your experience and creativity to develop more features around this base we build together.
Maybe you want to build a speed-trainer or add a fretboard/piano display. Whatever you try to build
Expand Down
Loading

0 comments on commit 2024f53

Please sign in to comment.