Deployment and User Documentation ‐ v2.1.0 - mbaron93/cs690project_learningtracker GitHub Wiki
This document is for running and maintaining the application.
- Go to the latest release
- Download the zip file SecondBrain2-1-0.zip
- Unzip it in your local using Windows PowerShell
- Install .NET Runtime v8.0
- Go inside the directory in which it has been unzipped
- Run "dotnet SecondBrain.dll" in your terminal to begin the program.
On run, the following menu option is given to the user. The goal of the app is to allow the user to upload and edit sources of information as they learn form them, including books, article and websites. It also allows the user to set reading and learning goals, and to receive reports on their progress. The menu provides the four main options of adding an information source, editing an information source, setting a goal or viewing a learning report. Select from one to begin the program, or exit whenever you are done. Your inputted sources and goals will be persistently saved.
The program allows the user to select from a Book or Article.
In both cases, the user can type in an author and a title name. The user also can add notes to the file that will be persistently saved.
If the user chooses Book, they will be prompted to enter in a total number of chapters followed by how many chapters have been completed. Inputting an amount under zero or greater than the number of chapters will re-prompt the user.
If the user chose article, they will be prompted to put in a percentage value between 0 and 100, explaining how much of the article they have completed.
The program allows the user to edit an existing source or head back to home if they mistakenly chose the option.
Upon selecting an existing source, the user can choose to edit the source or remove it from their source list entirely.
If the user edits the source, they can choose to update their note and provide a new description to the source's note
Regardless of whether the note was changed, the program also gives an an opportunity to update progress. If the user chooses to do so, they can input a new percentage between 0 and 100 if representing the percent of the article or book completed
Upon selecting this option, the user has the option to add a new goal, edit an existing goal, or change the overall amount of learning goals the user hopes to attain this year. This data is persistently saved.
When new goal is selected, the user is first prompted to type in a description of the goal. When a goal is first input, it is marked as incomplete.
The user is then prompted to type in the month and date of the goal. This assumes that it is the nearest instance of this month and date in the future. For example, if the user input a goal on April 20th, 2025 a date of July 1st would default to 2025 as the year, while a date of January 1st would default to 2026.
The user is returned to the home page after creating their goal. If they would like to edit an existing goal, they can select edit existing goal from the same "Set a Goal" Menu
The list of goals is printed out that have been persistently saved. The user can select from an option.
The user is prompted to mark completed, change the goal completion date or exit without making any changes. If they select mark completed, the goal is marked as complete and the user is returned to the home screen.
If the user chooses to edit the goal date, the user is prompted to re-enter the date by which they would like to complete this. Again, it saves the next instance of this date. It returns the user to the home screen.
In the program, the overall number of sources of information read can be compared to an overall goal. The default overall goal is 100 sources. The user can change this value by selecting the third option in the edit a goal method. The program will not change if the goal is 0 is inputted, and will reprompt the user if a negative number is put in.
When learning data is selected, a summary of information read, an overall sources to read goal, and a percentage of learning goals completed is demonstrated. The user is given the option to receive three more reports about 1.) All Sources Completed, 2.) All goals selected and 3.) Goal Progress is given.
If view "All Sources Completed" is selected, a table summarizing all sources completed is given and the user is returned to the main menu.
If "View All Goals" is selected, a table summarizing all goals, their completion status, and their original intended goal date are printed.
If "View Goal Progress" is selected, the program reminds the user of how many of learning goals they have reached, and prints out incomplete ones with the earliest due dates to remind them to complete them.
Upon the completion of each option, the program will return them to the original home page with the four main options.