From 7a28e15874796b3becf97c0193575d906d0cfd01 Mon Sep 17 00:00:00 2001 From: Terry Truong Date: Mon, 11 Jul 2022 13:19:18 +1000 Subject: Update backend documentation --- README.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index a283d6a..2770a71 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ managed using [Pip](https://pypi.org/project/pip). Tree data is stored using [Sq - **package.json**: Contains npm project information, such as package dependencies. - **package-lock.json**: Auto-generated by npm. Used for replicable installations. - **LICENCE.txt**: This project's license (MIT). -- **.gitignore**: Lists files to be ignored by Git. +- **.gitignore**: Lists files to be ignored if using [Git](https://git-scm.com/downloads). ### Client & Server - **src**: Contains most of the client-side code. - **index.html**: Holds code for the main page, into which code from 'src' will be included. @@ -36,11 +36,6 @@ Note: Running your own version of the client and server should be straightforward, but generating the database will take a long time. More details are in backend/data/README.md. -### Base Requirements -- **[Python](https://www.python.org/downloads)**: For running server-side code, and generating the database. -- **Pip**: For installing Python packages. Included in the Python download. -- **[Git](https://git-scm.com/downloads)** (optional): For downloading and viewing snapshots of the project. - ### Client Side 1. If you don't have npm or Node.js installed, you can download a Node installer from , which includes npm. This project was coded using version 16. -- cgit v1.2.3