JakeWharton / JakeWharton/timber
😇 I’d like to add this to the ReadMe Documentation.
- Dominant language
- Kotlin
- Stars
- 10.8k
- Forks
- 994
- Avg merge
- 17h 16m
- Merged PRs (30d)
- 17
Description
I added more details on the existing ReadMe file , focusing on setting up Timber once the dependencies have been downloaded.
### Step 1 : Create an Application class that inherrits from Application class .
```
open class MyProjectApplication : Application() {
}
```
### Step 2 : import the application package
import android.app.Application
### Step 3 : override the onCreate() method and initialize the Timber class
override the onCreate() method in your Application class
```
open class MyProjectApplication : Application() {
if (BuildConfig.DEBUG) {
Timber.plant(new DebugTree());
} else {
Timber.plant(new CrashReportingTree());
}
}
```
### Step 4 : Define it in your Android Manifest , Application tag
In your application tag, add it as a name attribute :
```
```
*There was no clear set up process after setting up the dependencies .*
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the existing README setup section and compare its dependency instructions with the proposed Application class and Android Manifest steps. Done means the README clearly explains Timber initialization after dependencies are downloaded, including the debug and release tree examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- android, kotlin
- Domain
- documentation, mobile
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100