Skip to content

Commit

Permalink
Improve documentation regarding setup and local.properties
Browse files Browse the repository at this point in the history
  • Loading branch information
michpohl committed Jun 17, 2024
1 parent 1fb8703 commit 13fc2c1
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ This is the repository for TIDAL Android SDK modules.

### First time setup
It is strongly recommended to run `local-setup.sh` right after cloning the repository. This will install the pre-commit git hook to run lint checks for your code. CI will also run these checks, but it's best to prevent CI failures by running the checks locally.
To run a specific module's test app, you might have to create a `local.properties` file in the root of the project, and add values according to that app's requirements.
``
### Creating a new module
1. Run the `generate-module.sh` script. It will prompt you to enter a module name using [PascalCase](https://pl.wikipedia.org/wiki/PascalCase).
After confirming the name, a new directory will be created with the basic module setup.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,14 @@ class MainActivity : ComponentActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)

/**
* This test app expects the following values in 'local.properties' to be set:
* TIDAL_CLIENT_ID: The id of the app created by you in the TIDAL developer portal
* TIDAL_CLIENT_SECRET: The secret generated for this id
* TIDAL_CLIENT_SCOPES: The scopes you selected in the portal, entered as a single
* string, scopes separated by a space
*/
val authConfig = AuthConfig(
// Make sure to provide your clientId and required credentials in local.properties
clientId = BuildConfig.TIDAL_CLIENT_ID,
clientSecret = BuildConfig.TIDAL_CLIENT_SECRET,
scopes = BuildConfig.TIDAL_CLIENT_SCOPES.split(" ").toSet(),
Expand Down

0 comments on commit 13fc2c1

Please sign in to comment.