Welcome to Pointer - Your well-being companion v01.0.0

Pointer goes far beyond a simple command-line interface. It is your ally in combating imposter syndrome and striving for a healthy balance between productivity and mental well-being. Every hour, the program encourages you to connect with yourself, explore your feelings, and identify obstacles that may undermine your self-confidence.

This software was born out of a common observation in the world of programming: we tend to focus on problems and obstacles, without paying enough attention to the moments when we have made progress or overcome difficulties. Pointer's goal is to regularly remind us of those moments when we have progressed smoothly, or even when obstacles have brought us a new perspective or an innovative solution.

How it works

1. Open Terminal:

Follow the steps mentioned earlier to open a terminal. Navigate to the Pointer File Directory: Once the terminal is open, use the cd command to navigate to the location where the Pointer file is stored. For example:

    cd ~/Desktop/pointer

Replace "~/Desktop/PointerApp" with the actual path to the directory where your Pointer file is located.

2. Create config.txt:

These commands will create a file named config.txt in the same directory where you execute the command. The file will contain the information provided by the user (first name, number of hours per week, number of days per week, start hour). Make sure to replace "Benjamin", "37", "5", and "8" with your own information ("first_name number_of_hours_per_week number_of_days_per_week start_hour").

• On Linux: Use the following command to create the file:

    echo "Benjamin 37 5 8" > config.txt

• On macOS (similar to Linux): Use the same command as for Linux:

    echo "Benjamin 37 5 8" > config.txt

• On Windows (Command Prompt): Use the following command to create the file:

    echo Benjamin 37 5 8 > config.txt

• On Windows (PowerShell): Use the same echo command with redirection, but use Out-File to create the file:

    echo "Benjamin 37 5 8" | Out-File -FilePath config.txt

3. Run Make Target:

You should install make and gcc sudo apt install make && sudo apt install gcc

Now, you can run the desired Makefile target by typing:

    make linux

Replace "windows" with the actual name of the target you want to run (linux / macos / windows).

4. Execute Pointer:

After running the Makefile target, proceed to execute the Pointer program by typing:

    ./pointer

This assumes that "pointer" is the name of the executable file. If the name is different, replace "pointer" with the correct name.

Once Pointer is launched, you will receive a notification every hour prompting you to answer certain questions in your terminal. Once your workday is finished, simultaneously press Ctrl + C to stop the program. At that moment, a markdown file named "daily-review.md" will be automatically created, containing notes from each day. On Friday, when you stop the program, you will receive a summary of the week in the same text file. This summary will include an aggregated overview of your well-being and productivity throughout the week.