Skip to content

Commit

Permalink
Add Getting started block in readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
majorkik committed Jul 11, 2021
1 parent d9db876 commit 2e8fab8
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 1 deletion.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,35 @@

![Future modules](docs/image/future-modules.svg?raw=true)

## Getting started

There are a few ways to open this project.

### Android Studio

1. `Android Studio` -> `File` -> `New` -> `From Version control` -> `Git`
2. Enter `https://github.com/majorkik/MovieBox-Compose.git` into URL field an press `Clone` button

### Command-line + Android Studio

1. Run `git clone https://github.com/majorkik/MovieBox-Compose.git` command to clone project
2. Open `Android Studio` and select `File | Open...` from the menu. Select cloned directory and press `Open` button

### Project configuration

Add parameters in the locale.properties file as shown in the example below.

```properties

keyTmdb="Your TMDb Key"

```

#### Where can I get a TMDb API key?

1. Open [TheMovieDatabase](https://www.themoviedb.org/) -> `Login/Join TMDb` -> `Profile` -> `Settings` -> `API` -> Copy `API Key (v3 auth)`
2. Paste copied key into `local.properties` file (`keyTmdb`)

## Links

Here I will leave useful links to utilities, projects or articles that may come in handy when developing mobile applications.
Expand Down
2 changes: 1 addition & 1 deletion buildSrc/src/main/kotlin/AndroidConfig.kt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ object AndroidConfig {
const val targetSdk = 30
const val buildTools = "30.0.2"

const val versionCode = 46
const val versionCode = 47
const val versionName = "0.6.1"

const val applicationId = "com.majorkik.movieboxcompose"
Expand Down

0 comments on commit 2e8fab8

Please sign in to comment.