Project

note_taker

0.0
No release in over a year
A Note taking gem
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 0

Runtime

 Project Readme

NoteTaker

Just a small ruby gem to help you keep your notes.

It uses your default editor ($EDITOR) to open the markdown notes that it creates.

Installation

To use note_taker just install it with the below

$ gem install note_taker

Usage

The default directory is ~/work_notes if you want to change this you need to add a ~/.note_config.yaml. Then add the following to the config

general:
  directory: <path-to-notes-dir>

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/note_taker.