giorgiberiashvili / cli-timer Goto Github PK

Description

It might be neat to display the ASCII version of the application's logo while running the application.

Unsure of the time when it will be outputted on the terminal.

In order for this issue to be resolved, #5 must be dealt with first.

Description

Right now, it is not possible to keep track of the timer usage outside of the terminal, and even then, it is temporary. It would not be so bad to implement logging for the program.

---

Objective

Make logging possible by following these steps:

• create or update a file named "cli-timer.log" where all of the logging messages will be stored
• come up with a human-readable log format
• enable timestamp for the messages
• specify which file is updating the "cli-timer.log"
• specify the level of the log
• keep it simple
• enable or disable logging based on the execution option

Description

It might be useful for the user to be able to control whether the application will use the default configuration or a custom one configured by the user.

Since the project already uses the dirs package (with success), it will leverage its functionality for the task as well.

The configuration file, alongside the log file, will be located in the user's configuration directory.
Here are the paths:

• Linux: /home/{user}/.config
• macOS: /Users/{user}/Library/Preferences
• Windows: C:\Users\{user}\AppData\Roaming

Where the {user} will be the user's username.

---

Objective

The functionalities should probably include:

• generating the default configuration the first time user runs the application
• if the user wants to edit the configuration file through the application, he will pass a flag
• just having sane options will suffice

Description

Cargo.toml only includes base information generated by Cargo version 1.33.0, which does not depict the full metadata of the project.

---

Objective

Add the following fields to Cargo.toml:

• description
• documentation
• homepage
• repository
• readme
• keywords
• categories
• license

Description

Self-explanatory.

Unsure of the image format, but it will be made using an open-source application.

Description

The package appears to be in a usable state. It might make sense to publish it on crates.io and update it regularly until it is finished.