Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update README.adoc and repo branding #26

Merged
merged 7 commits into from
Oct 7, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
90 changes: 74 additions & 16 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,22 +1,75 @@
= VISIT: Patient Tracker for Doctors On-The-Go
ifdef::env-github,env-browser[:relfileprefix: docs/]
++++
<h1 align="center">
<br>
<a href="https://roc.ms/visitapp"><img src="docs/images/icons/LogoTitle.png" alt="VISIT" width="400"></a>
<br>
VISIT
<br>
</h1>

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]]
<h4 align="center">A Patient Tracking Application for Doctors On-The-Go.</h4>

<p align="center">
<a href="https://travis-ci.org/AY1920S1-CS2103T-F12-2/main"><img src="https://travis-ci.org/AY1920S1-CS2103T-F12-2/main.svg?branch=master"></a>
<a href='https://coveralls.io/github/AY1920S1-CS2103T-F12-2/main?branch=master'><img src='https://coveralls.io/repos/github/AY1920S1-CS2103T-F12-2/main/badge.svg?branch=master' alt='Coverage Status' /></a>
</p>

ifdef::env-github[]
image::docs/images/Ui.png[width="900"]
endif::[]
<p align="center">
<a href="#key-features">Key Features</a> •
<a href="#how-to-use">How To Use</a> •
<a href="#download">Download</a> •
<a href="#site_map">Site Map</a> •
<a href="#acknowledgements">Acknowledgements</a> •
<a href="#license">License</a>
</p>

ifndef::env-github[]
image::images/Ui.png[width="900"]
endif::[]
<p align="center">
<img src="docs/images/Ui.png" alt="Ui.png" width="900">
</p>

* 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 <<UserGuide#, here>>!

== 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

Expand All @@ -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]
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -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)
]

Expand Down
Binary file added docs/images/icons/Logo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/icons/LogoBG.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/icons/LogoInvert.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/icons/LogoInvertBG.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/icons/LogoTitle.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/icons/LogoTitleBG.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -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