aboutsummaryrefslogtreecommitdiff
path: root/src/README.md
diff options
context:
space:
mode:
authorTerry Truong <terry06890@gmail.com>2022-07-10 23:41:20 +1000
committerTerry Truong <terry06890@gmail.com>2022-07-10 23:41:20 +1000
commita8f80a02b88055cfcb45664ce3a3d24c2b2da98c (patch)
tree021072aa131b2e141978e0223f6e37dfcb1cf1cd /src/README.md
parentf0df00add356c0ee4cc8743a9ceeb276ae207715 (diff)
Update project-level and client-side documentation
Diffstat (limited to 'src/README.md')
-rw-r--r--src/README.md41
1 files changed, 21 insertions, 20 deletions
diff --git a/src/README.md b/src/README.md
index 23f05ee..5c88b2e 100644
--- a/src/README.md
+++ b/src/README.md
@@ -1,21 +1,22 @@
# Files
-- main.ts: Included by ../index.html. Creates the main Vue component.
-- App.vue: The main Vue component.
-- components:
- - Tile.vue: Displays a tree-of-life node.
- - TileInfoModal.vue: Modal displaying info about a Tile's node.
- - SearchModal.vue: Modal providing a search bar.
- - SettingsModal: Modal displaying configurable settings.
- - HelpModal.vue: Modal displaying help info.
- - AncestryBar.vue: Displays ancestors of the outermost Tile.
- - TutorialPane.vue: Displays tutorial content.
- - LoadingModal.vue: Displays a loading indicator.
- - SButton.vue: Simple button component.
- - IconButton.vue: Simple button component containing an SVG icon.
- - SCollapsible.vue: Simple collapsible-content component.
- - icon: Contains components that display SVG icons.
-- lib.ts: Contains classes/types and utility functions.
-- layout.ts: Contains code for laying out Tiles.
-- util.ts: Contains utility functions.
-- index.css: Included by main.ts. Provides Tailwind's CSS classes.
-- env.d.ts: From Vite's template files.
+- **main.ts**: Included by ../index.html. Creates the main Vue component.
+- **App.vue**: The main Vue component.
+- **components**:
+ - **Tile.vue**: Displays a tree-of-life node.
+ - **TileInfoModal.vue**: Modal displaying info about a Tile's node.
+ - **SearchModal.vue**: Modal providing a search bar.
+ - **SettingsModal**: Modal displaying configurable settings.
+ - **HelpModal.vue**: Modal displaying help info.
+ - **AncestryBar.vue**: Displays ancestors of the outermost Tile.
+ - **TutorialPane.vue**: Displays tutorial content.
+ - **LoadingModal.vue**: Displays a loading indicator.
+ - **SButton.vue**: Simple button component.
+ - **IconButton.vue**: Simple button component containing an SVG icon.
+ - **SCollapsible.vue**: Simple collapsible-content component.
+ - **icon**: Contains components that display SVG icons.
+- **tol.ts**: Holds types for tree-of-life data.
+- **layout.ts**: Holds code for laying out tiles.
+- **lib.ts**: Holds project-wide globals.
+- **util.ts**: Holds utility functions.
+- **index.css**: Included by main.ts. Provides Tailwind's CSS classes.
+- **env.d.ts**: From Vite's template files.