Code Monkey home page Code Monkey logo

researchnote's Introduction

researchnote

Manage a research notebook using reStructuredText files.

Recommended settings

Add the following aliases to your .bash_profile:

alias rnc="researchnote create"
alias rne="researchnote edit"
alias rnl="researchnote list"

ResearchNote will try to read a configuration file named .researchnoterc in the user's home folder. If this configuration file is not present, it is wise to set the EDITOR environment variable:

export EDITOR=vim

The configuration file can contain the following values:

author = "Your Name"
editor = "vim"
notes_dir = "/path/to/research/notes"

Create a note

Create a note with

researchnote create NOTE NAME

This will touch a new file in the notes_dir directory and create a note skeleton in that file. If the EDITOR is set, it is used to open the file for editing. The basic skeleton looks as follows:

A note name
===========

:date: 2012-12-02
:author: Your Name
:tags: 

New files are named using the YYYY-MM-DD_A_note_name.rst template.

Editing a note

It is possible to edit a note with

researchnote edit IDENTIFIER

where IDENTIFIER is either a note name, a date or a file name.

Listing all notes

To list all notes, use

researchnote list

This will list note titles and dates in chronological order.

Deleting a note

No! Don't do that! It is very bad practice to delete research notes. ResearchNote does not allow to delete notes.

researchnote's People

Contributors

loicseguin avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Forkers

assaflavi

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.