intro

welcome to habitmap!

habitmap is a command-line app to track your habits and visualise how committed you are to making or maintaining them with colorful heatmaps!

habitmap allows you to:

  • add and remove habits
  • track your habits
  • customise how many steps each habit has (see the explanation on steps here)
  • print out several types of heatmaps based on each habit
  • customise the colors in the heatmaps + make your own aliases for the colors!

contribute

habitmap is open-source and free! the sourcecode for habitmap can be found here on GitHub.

for any feature requests, feel free to open a new issue here.

if you'd like to make your own features and integrate them into habitmap, feel free to make your own branch and then pull request or a fork if the feature does not get accepted. in the latter case, do remember to link and credit the original habitmap repository.

to see the source code for this book, see the habitmap-docs repository (also on GitHub).

license

both habitmap and its documentation are under the GNU General Public License v3.0.

this documentation was written in mdBook.