Skip to content
Manage notes in command line
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
spec
src
.editorconfig
.gitignore
.travis.yml
LICENSE
Makefile
README.md
shard.yml

README.md

Noteesh

Tracking notes in your command line

Installation

Build from code source

You should have the crystal compiler installed check it out here

  1. Clone this repo
$ cd some/path
$ git clone https://github.com/arandilopez/noteesh.git
$ cd noteesh/
  1. Run make commands
$ sudo make
# then run
$ sudo make install

Update

  • If you cloned the repo, pull new changes
$ cd path/to/noteesh
$ git pull origin master
$ sudo make reinstall

Usage

  • Check your notes
$ noteesh
  • Add a new note
$ noteesh --add "Buy a coke"
  • Mark a note as done
$ noteesh --done 1
  • Clear your notes
$ noteesh --clear

Development

Run the make command to compile as development

$ make compile
# then run the bin file
$ bin/noteesh

Run make test to run a build and specs

$ make test

Contributing

  1. Fork it ( https://github.com/arandilopez/noteesh/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.