From ba50d48f2336ae1b3d5652a2c9f4a9790212bb15 Mon Sep 17 00:00:00 2001 From: Myzel394 <50424412+Myzel394@users.noreply.github.com> Date: Fri, 23 Feb 2024 22:51:31 +0100 Subject: [PATCH] chore(docs): Add documentation for ui folder Signed-off-by: Myzel394 <50424412+Myzel394@users.noreply.github.com> --- app/src/main/java/app/myzel394/alibi/ui/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 app/src/main/java/app/myzel394/alibi/ui/README.md diff --git a/app/src/main/java/app/myzel394/alibi/ui/README.md b/app/src/main/java/app/myzel394/alibi/ui/README.md new file mode 100644 index 0000000..bbf323c --- /dev/null +++ b/app/src/main/java/app/myzel394/alibi/ui/README.md @@ -0,0 +1,14 @@ +# ui + +This folder contains all user interfaces. The folder is structured as follows: + +* `components`: contains all reusable components + * `atoms`, `molecules`, `organisms`, `pages`: contains components that are generic and can be + reused in different contexts + * `Screen/{atoms,molecules,organisms,pages}`: contains components that are specific to a + screen +* `screens`: contains all screens. Screens are composed of components from the `components` folder +* `models`: contains view models used by the screens +* `utils`: contains general utility functions + +The root Kotlin files are used for the general setup of the UI. \ No newline at end of file