From 00d4ff767aa6009b4e4e992f73528a205b1df9e4 Mon Sep 17 00:00:00 2001 From: Alessandro Fael Garcia Date: Tue, 9 Aug 2016 12:18:14 +0100 Subject: [PATCH] Update README.md --- README.md | 40 ++++++++++++++++++++++++++++++++++++++-- 1 file changed, 38 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1a1d081..3209d14 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,38 @@ -# patient-management-system -A patient management system +# Patient Management System + +A fully functional Patient Management System written in Java with its corresponding GUI. + +## How To Use + +* The Patient Management System requires the practitioner to log in using a username/password pair. The default values are: + * **username:** admin + * **password:** 1234 +* A new patient can be registered with basic personal details: +* Upon selecting the patient from a list more fields become visible allowing the user to edit comments, appointments, and add or remove pictures. +* The field containing the medical condition data is clickable and points to the website indicated by the practitioner at patient creation. +* All fields of a patient record can be edited. How to edit a field depends on the field selected: + * If the user wishes to edit personal details then it is necessary press the edit button. + * Comments and appointments can be edited on the fly on their respective tab. + * Photos can be added or deleted on their respective tabs. +* A patient record can be deleted after the practitioner confirms its deletion. +* The list of patients can be search based on a series of fields. (Only sensible fields are included in the search table). +* A list of selected patients can be exported as a JSON object. +* A list of patient records can be imported as a JSON object and appended to the existing ones in the management system. + +## Setup + +* **Option 1:** Use the patient-management-system.jar binary included in release v1.0. This requires no setup at all. +* **Option 2:** Build the application from the source files: + * `/src` contains the .java application source files. + * `/res` contains the images used by .java source files. + * `/lib` contains the JSON third party library used to save and read JSON text files. + +## Notes +* The official JSON third party java library is used to save and read JSON text files. This library can be found [**_here_**] (http://www.json.org/java/) and is open source. You will need to add the library to your build path to be able to launch the project. +* An extensive Javadoc can be found in the `/doc` subfolder. +* A logger is initialised in the directory where the jar is launched. This can be useful for debugging. + +## Further Work +* Allow the practitioner to create a new username and password upon launching the application for the first time. +* Resize images dynamically. +* Find a better method to store images.