Skip to content

README.md

Latest commit

 

History

History
54 lines (36 loc) · 1.96 KB

README.md

File metadata and controls

54 lines (36 loc) · 1.96 KB

Overview

Project Title: Java CLI-Based Student Study Planner

Project Description: A simple command-line interface application developed in Java to help students manage and organize their study sessions effectively. The software enables users to input, view, and manage their study schedules and export them in CSV format for easy access and sharing.

Project Goals:

  1. Provide an intuitive and easy-to-use CLI-based interface.
  2. Allow users to input and manage study session details.
  3. Support exporting schedules to CSV files.
  4. Ensure reliable and error-free operation through robust error handling.

Instructions for Build and Use

  1. Steps to build and/or run the software
  2. Install Java JDK version 17 or newer on your system.
  3. Clone the repository: git clone https://github.com/gixtrem/JavaStudyPlanner.git
  4. Open the project in your chosen IDE (e.g., VS Code, IntelliJ IDEA, Eclipse).
  5. Navigate to the src folder and run the Main.java file.

Instructions for using the software:

  1. Start the application by executing the Main class.
  2. Follow the command-line prompts to add study sessions.
  3. Choose options from the menu to view or export schedules as a CSV file.

Development Environment

To recreate the development environment, you need the following software and/or libraries with the specified versions:

  • Java Development Kit (JDK) 17 or newer
  • Visual Studio Code (latest stable version)
  • VS Code Extensions:
  • Extension Pack for Java
  • GitLens (optional, recommended)

Useful Websites to Learn More

I found these websites useful in developing this software:

Future Work

The following items I plan to fix, improve, and/or add to this project in the future:

  • Add more functionalities to my code like set timers and reminders
  • Connect to active database to save user profile and memory.