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 /README.md | |
| parent | abb936f5d76f7fe5cec1e8948d287da86643d504 (diff) | |
Update some client-side READMEs
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 21 |
1 files changed, 15 insertions, 6 deletions
@@ -1,5 +1,4 @@ -Grid of Life -============ +# Grid of Life An interactive visualisation of the biological tree of life. @@ -10,7 +9,17 @@ Each tile represents a group of organisms with a common ancestor. - Double-clicking on a tile expands it to fill the whole view. Other tiles will be moved to the side. -Files -===== -- backend/: Contains code for running the server, and generating tree-of-life data -- +# Files +- package.json: Contains project information, including what packages need to be installed. +- src: Contains most of the client-side code. +- index.html: Holds code for the main page, into which code from src/ will be included. +- backend: Contains code for running the server, and generating tree-of-life data +- public: Contains files to be copied unchanged when building for production. +- tailwind.config.js: For configuring Tailwind. +- postcss.config.js: For configuring Tailwind. +- tsconfig.json: For configuring Typescript. +- vite.config.js: For configuring Vite. +- .gitignore: Lists files to be ignored by Git. + +# Overview +# Instructions |
