From d54e1a4607debb457d30068cc4d20fe92cedac6c Mon Sep 17 00:00:00 2001 From: Terry Truong Date: Thu, 23 Jun 2022 15:13:36 +1000 Subject: Update some client-side READMEs --- README.md | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 46e044d..d588496 100644 --- a/README.md +++ b/README.md @@ -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 -- cgit v1.2.3