= Notably ifdef::env-github,env-browser[:relfileprefix: docs/]

image:https://travis-ci.com/AY1920S2-CS2103T-W17-2/main.svg?branch=master["Build Status", link="https://travis-ci.com/AY1920S2-CS2103T-W17-2/main"] image:https://codecov.io/gh/AY1920S2-CS2103T-W17-2/main/branch/master/graph/badge.svg["codecov", link="https://codecov.io/gh/AY1920S2-CS2103T-W17-2/main"]

ifdef::env-github[] image::docs/images/Ui.png[] endif::[]

ifndef::env-github[] image::images/Ui.png[] endif::[]

Are you an NUS student who gets easily frustrated with your unstructured notes? Do you write a lot of notes but find it difficult to find them afterwards?

If so, Notably will definitely be your best note-taking app buddy!

• Main target user: tech-savvy NUS students.
• Optimized for those who prefer to work with a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI), Notably allows you to get your notes taken down faster than traditional GUI apps.
• Notably can find all your notes for you based on the keywords you input. If you cannot remember the precise keywords, fret not! Notably will give you auto corrections and suggestions.

Note-taking? Notably.

== Site Map

• <<UserGuide#, User Guide>>
• <<DeveloperGuide#, Developer Guide>>
• <<AboutUs#, About Us>>
• <<ContactUs#, Contact Us>>

== Acknowledgements

• Some parts of this sample application were inspired by the excellent http://code.makery.ch/library/javafx-8-tutorial/[Java FX tutorial] by Marco Jakob.
• Libraries used: https://openjfx.io/[JavaFX], https://github.com/FasterXML/jackson[Jackson], https://github.com/junit-team/junit5[JUnit5]
• This project is adapted from https://se-education.org[AddressBook-Level3] project created by SE-EDU initiative.

== Licence : link:LICENSE[MIT]