From 5409d1de835884e4c3deb991e5609ae73693d427 Mon Sep 17 00:00:00 2001 From: adsilb Date: Fri, 10 Sep 2021 18:03:42 -0700 Subject: [PATCH] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1dff58f..9f343b8 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ python .\manage.py runserver You shouldn't need to modify `manage.py` at all. -There are two top level folders in the repository, `website` and `search` +There are three top level folders in the repository, `website`, `search`, and `import scripts` `website/settings.py`: This is probably the only file under `website` that you might want to modify. The location of the database file is specified here. Currently, it is set to `../TargetLink.db`, which is one level up from the root directory of this repo. The reason for that is that it was too large to upload to Github. @@ -25,3 +25,5 @@ There are two top level folders in the repository, `website` and `search` `search/views.py`: This file is the back-end logic for the main views, currently called `index` (the landing page) and `gene_details` (what happens when the user highlights a particular gene) `templates/search/index.html`: This file contains the HTML of the front end, with Django template code and javascript interspersed. + +`import scripts`: This folder, not involved in the actual website, contains Python scripts for automatically creating TSV files and inserting the data into a SQLite database. It is not currently complete but should be easy to add to by copying and modifying the existing scripts.