diff options
| author | Terry Truong <terry06890@gmail.com> | 2022-06-23 15:13:36 +1000 |
|---|---|---|
| committer | Terry Truong <terry06890@gmail.com> | 2022-06-23 15:13:36 +1000 |
| commit | d54e1a4607debb457d30068cc4d20fe92cedac6c (patch) | |
| tree | 9636aa59842f33bf369c0cda01a50f11e3c4ee10 /src | |
| parent | abb936f5d76f7fe5cec1e8948d287da86643d504 (diff) | |
Update some client-side READMEs
Diffstat (limited to 'src')
| -rw-r--r-- | src/README.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/src/README.md b/src/README.md new file mode 100644 index 0000000..bccc3b1 --- /dev/null +++ b/src/README.md @@ -0,0 +1,17 @@ +# 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, and can include child nodes. + - AncestryBar.vue: Displays ancestors of the top-level Tile. + - TutorialPane.vue: Displays tutorial content. + - TileInfoModal.vue: Modal displaying info about a Tile's node. + - SearchModal.vue: Modal with a search bar. + - SettingsModal: Modal displaying configurable settings. + - HelpModal.vue: Modal displaying help info. + - RButton.vue: Basic button component. + - icon: Contains components that display SVG icons. +- layout.ts: Contains code for laying out Tiles. +- lib.ts: Contains classes/types and utility functions. +- index.css: Included by main.ts. Provides Tailwind's CSS classes. +- env.d.ts: From Vite's template files. |