/notr

Simple CLI note taking

Primary LanguageGoApache License 2.0Apache-2.0

notr

notr is a lightweight cli tool for keeping track of problems and their solutions.

The basic use case is that whenever there is a problem the user can open a problem and then close it later once they have the solution without having to open another application.

This hopes to solve the times when we say ...

  • "I'm sure I'll remember how I fixed x"
  • "How did I solve y problem?"
  • "How did I fix that error during my builds?"

The list goes on and on ...

How to install

Run the install script inside the directory. Following that add the following lines in your .bashrc, .zshrc, or whatever you use.

# Add the user's private bin if it exists
if [ -d "$HOME/bin" ] ; then
  PATH="$HOME/bin:$PATH"
fi

From there open up a terminal and you should be able to run the command below to see how the app works!

notr --help

How to contribute

  1. Fork the repo
  2. Create an issue with your planned contribution
  3. If you have been assigned an issue, name the branch like <issue_label>/some-descriptive-name
  4. Write tests if necessary for the changes you have created
  5. Push to the branch git push origin <issue_label>/some-descriptive-name
  6. Create a Pull Request