Skip to content

Latest commit

 

History

History
178 lines (115 loc) · 5.45 KB

README.md

File metadata and controls

178 lines (115 loc) · 5.45 KB
Raw

codecov

Contributors Forks Issues


NUSearch

A GUI application to help you quickly search for the contacts of NUS faculty members!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. Contact
  7. Acknowledgments

About The Project

NUSearch is a GUI application that allows students to easily and conveniently find the contacts of faculty members so that they may contact members of faculty more easily.

The product is not an official NUS project, although the project was conceived by and worked on by NUS students during the CS2103T module.

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

(back to top)

Getting Started

Read the getting started segment to understand how to get started on using NUSearch

Installation

Follow these steps closely to get started.

  1. Download our latest .jar file here
  2. Locate the .jar file in your downloads folder
  3. Open the .jar file to run the application

Usage

For more usage examples, please refer to the Documentation

(back to top)

Roadmap

  • Add Changelog
  • Add back to top links
  • Add Additional Templates w/ Examples
  • Add "components" document to easily copy & paste sections of the readme

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Contact

Eugene Chia - @linkedin - [email protected]

Sim Jia Ming - @linkedin - [email protected]

Shurvir Arora - @linkedin - [email protected]

Tan Wei En - @linkedin - [email protected]

Project Link: https://github.com/AY2122S2-CS2103T-W11-4/tp

(back to top)

Acknowledgments

The team would like to give a big shout out these projects, from which we have used parts of in our project. Special shout out to you Prof. Damith <3.

(back to top)