diff options
| author | Terry Truong <terry06890@gmail.com> | 2023-01-22 11:32:28 +1100 |
|---|---|---|
| committer | Terry Truong <terry06890@gmail.com> | 2023-01-22 12:11:59 +1100 |
| commit | 436dd015471cbdea443cfd98536e55e683833c48 (patch) | |
| tree | f833560544264855f1e0f22e830bbbd17dc51c28 /src/README.md | |
| parent | 7348360fead15f85f368d4d4d248e41aa4a2f4f2 (diff) | |
Add deployment docs and script
Add DEPLOY.md and prebuild.sh
Update READMEs
Change project name
Diffstat (limited to 'src/README.md')
| -rw-r--r-- | src/README.md | 19 |
1 files changed, 17 insertions, 2 deletions
diff --git a/src/README.md b/src/README.md index 409e796..5ef7892 100644 --- a/src/README.md +++ b/src/README.md @@ -2,6 +2,21 @@ - **main.ts**: Included by ../index.html. Creates the main Vue component. - **App.vue**: The main Vue component. - **components**: - - **TestComponent.vue**: For testing. -- **index.css**: Included by main.ts. Provides Tailwind's CSS classes. + - **TimeLine.vue**: Displays an interactive timeline. + - **BaseLine.vue**: Displays a timeline overview. + - **InfoModal.vue**: Modal displaying event info. + - **SearchModal.vue**: Modal providing a search bar. + - **SettingsModal.vue**: Modal displaying configurable settings. + - **HelpModal.vue**: Modal displaying help info. + - **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. +- **store.ts**: App global storage. +- **lib.ts**: Holds project-wide globals. +- **util.ts**: Holds utility functions. +- **rbtree.ts**: Red-black tree implementation. +- **index.css**: Included by main.ts. Provides Tailwind's CSS classes. - **vite-env.d.ts**: From Vite's template files. +- **global.d.ts**: Temporary typescript overrides. |