📝 Create README for each layer and module

READMEs created for better code comprehension
This commit is contained in:
Igor Escodro
2019-06-15 10:48:29 -03:00
parent 8eab140562
commit 851152a929
13 changed files with 39 additions and 0 deletions

3
app/README.md Normal file
View File

@ -0,0 +1,3 @@
# App
Layer representing the Android Application. It contains the base UI structure.

3
data/README.md Normal file
View File

@ -0,0 +1,3 @@
# Data
Layer to provide the data fetch and representation for the application.

3
data/domain/README.md Normal file
View File

@ -0,0 +1,3 @@
# Domain
Module to provide the application logic and the use cases to be used by the features.

3
data/local/README.md Normal file
View File

@ -0,0 +1,3 @@
# Local
Module to represent and store the local data structure.

3
data/model/README.md Normal file
View File

@ -0,0 +1,3 @@
# Model
Module to represent the database model.

3
features/README.md Normal file
View File

@ -0,0 +1,3 @@
# Features
Layer to provide the features to be interacted by the user.

3
features/alarm/README.md Normal file
View File

@ -0,0 +1,3 @@
# Alarm
Module representing the Alarm Notification feature. This feature handles the Task to be notified in the given time.

View File

@ -0,0 +1,3 @@
# Category
Module representing the Task Category feature. This feature helps to separate the Tasks by default or used defined categories.

View File

@ -0,0 +1,3 @@
# Preference
Module representing the Preference feature. This feature provide the user the app information and settings.

3
features/task/README.md Normal file
View File

@ -0,0 +1,3 @@
# Task
Module representing the Task feature. This feature is the main app feature where the user can create custom tasks to be reminded.

3
libraries/README.md Normal file
View File

@ -0,0 +1,3 @@
# Libraries
Layer to provide the libraries, with common code, for the other modules.

3
libraries/core/README.md Normal file
View File

@ -0,0 +1,3 @@
# Core
Module representing the Core library. This library provides the common code between the modules to be reused.

View File

@ -0,0 +1,3 @@
# Navigation
Module representing the Navigation library. This library provides the navigation between screens and modules using Android Jetpack Navigation.