diff --git a/README.adoc b/README.adoc index 0557bf7c98a..f8b3d28e45e 100644 --- a/README.adoc +++ b/README.adoc @@ -1,22 +1,75 @@ -= VISIT: Patient Tracker for Doctors On-The-Go -ifdef::env-github,env-browser[:relfileprefix: docs/] +++++ +

+
+ VISIT +
+ VISIT +
+

-https://travis-ci.org/AY1920S1-CS2103T-F12-2/main[image:https://travis-ci.org/se-edu/addressbook-level3.svg?branch=master[Build Status]] -https://coveralls.io/github/AY1920S1-CS2103T-F12-2/main?branch=master[image:https://coveralls.io/repos/github/se-edu/addressbook-level3/badge.svg?branch=master[Coverage Status]] +

A Patient Tracking Application for Doctors On-The-Go.

+

+ + Coverage Status +

-ifdef::env-github[] -image::docs/images/Ui.png[width="900"] -endif::[] +

+ Key Features • + How To Use • + Download • + Site Map • + Acknowledgements • + License +

-ifndef::env-github[] -image::images/Ui.png[width="900"] -endif::[] +

+Ui.png +

-* Introducing *VISIT*, a Patient Tracker for Doctors-On-The-Go. -* VISIT is a desktop application that allows doctors to manage all of their _patients_ and _appointments_ in a simple, handy app. -* Doctors are able to keep track of their patients across visits, ensuring a continuity of care on subsequent visits. -* VISIT also reminds doctors of all of their upcoming appointments so that they never miss an appointment. +++++ + +== Key Features + +* Completely CLI-Friendly 💻 +** Prefer the keyboard? VISIT is made to be entirely operable just using your keyboard! +* Patient Profiling 👪 +** Keep all the key patient details like names, addresses and contact information of your patients easily accessible. +* Visit Tracking 🏠 +** Keep track of the history of past visits by the same patient to provide holistic and personalized healthcare. +* Reminder System 📆 +** Can't remember when your next appointment is? VISIT reminds you when your next consultation is. +* Alias / Macro command support +* Tagging and Search functionality +* Save patient information as a text file +* Cross platform +** Windows, macOS and Linux ready. + +== How To Use + +To run this application, you'll need https://www.oracle.com/technetwork/java/javase/downloads/jdk11-downloads-5066655.html[Java 11] installed on your computer. + +Run the program then, try typing the following commands: + +[source, sh] +---- +# Adds a Patient with details +$ add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 + +# Adds a visitation report +$ addVisit n/Betsy Crowe t/12/12/12 e/Betsy@example.com + +# Find all patients matched to the query 'John', 'Tim' or 'Betsy' +$ find John Tim Betsy + +# Show the full profile of the patient at position 1 +$ profile 1 +---- + +For other commands, check out our User Guide at <>! + +== Download + +You can https://github.com/AY1920S1-CS2103T-F12-2/main/releases[download] the latest installable version of VISIT for Windows, macOS and Linux. == Site Map @@ -28,6 +81,11 @@ endif::[] == Acknowledgements * This application is built upon AddressBook-Level3 Project created by SE-EDU initiative at https://se-education.org -* Libraries used: https://openjfx.io/[JavaFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/junit-team/junit5[JUnit5] +* Libraries used: +- https://openjfx.io/[JavaFX] +- https://github.com/FasterXML/jackson[Jackson] +- https://github.com/junit-team/junit5[JUnit5] + +== License -== Licence : link:LICENSE[MIT] +link:LICENSE[MIT] diff --git a/build.gradle b/build.gradle index 93029ef8262..afa2ade4c36 100644 --- a/build.gradle +++ b/build.gradle @@ -134,7 +134,7 @@ asciidoctor { idseparator: '-', 'site-root': "${sourceDir}", // must be the same as sourceDir, do not modify 'site-name': 'AddressBook-Level3', - 'site-githuburl': 'https://github.com/se-edu/addressbook-level3', + 'site-githuburl': 'https://github.com/AY1920S1-CS2103T-F12-2/main', 'site-seedu': true, // delete this line if your project is not a fork (not a SE-EDU project) ] diff --git a/docs/images/icons/Logo.png b/docs/images/icons/Logo.png new file mode 100644 index 00000000000..79f36fdb467 Binary files /dev/null and b/docs/images/icons/Logo.png differ diff --git a/docs/images/icons/LogoBG.png b/docs/images/icons/LogoBG.png new file mode 100644 index 00000000000..e8a6a76b575 Binary files /dev/null and b/docs/images/icons/LogoBG.png differ diff --git a/docs/images/icons/LogoInvert.png b/docs/images/icons/LogoInvert.png new file mode 100644 index 00000000000..9a4b4142ccc Binary files /dev/null and b/docs/images/icons/LogoInvert.png differ diff --git a/docs/images/icons/LogoInvertBG.png b/docs/images/icons/LogoInvertBG.png new file mode 100644 index 00000000000..e8dfe9f256a Binary files /dev/null and b/docs/images/icons/LogoInvertBG.png differ diff --git a/docs/images/icons/LogoTitle.png b/docs/images/icons/LogoTitle.png new file mode 100644 index 00000000000..738b2a48663 Binary files /dev/null and b/docs/images/icons/LogoTitle.png differ diff --git a/docs/images/icons/LogoTitleBG.png b/docs/images/icons/LogoTitleBG.png new file mode 100644 index 00000000000..d77fe6b5e72 Binary files /dev/null and b/docs/images/icons/LogoTitleBG.png differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index 44e7c4d1d7b..6e92d4bfde1 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,5 +1,6 @@ +#Thu Sep 26 18:52:14 AEST 2019 distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-5.2.1-bin.zip zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-5.2.1-all.zip