Project

tchart

0.0
No commit activity in last 3 years
No release in over 3 years
tchart reads a text file containing date-based data, for example employment history, and generates TikZ code to render a chart of the data. The generated TikZ chart can then be embedded in a TeX or LaTeX document, such as a resume.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 0
~> 10
 Project Readme

Gem Version Build Status Code Climate Coverage Status Dependencies

What is tchart?

A command line utility that generates TikZ code to draw a chart of date-based data.

Documentation

Here (documentation source is here).

Development Setup

#####Requirements:

#####Install: In a terminal window on the host machine:

$ mkdir -p ~/work/tchart
$ cd ~/work/tchart
$ curl -L https://raw.github.com/milewdev/tchart/master/Vagrantfile -o Vagrantfile
$ vagrant up --provider=vmware_fusion
...

#####Check installation: In a terminal window on the vm (guest machine):

$ cd ~/Documents/tchart
$ ./_test
--------------------------------------------------------------------------------
/Library/Ruby/Gems/2.0.0/gems/rest-client-1.6.7/lib/restclient/exceptions.rb:157: warning: assigned but unused variable - message
/Library/Ruby/Gems/2.0.0/gems/rest-client-1.6.7/lib/restclient/exceptions.rb:167: warning: assigned but unused variable - message
/Library/Ruby/Gems/2.0.0/gems/rest-client-1.6.7/lib/restclient/response.rb:11: warning: method redefined; discarding old body
/Library/Ruby/Gems/2.0.0/gems/rest-client-1.6.7/lib/restclient/payload.rb:47: warning: mismatched indentations at 'end' with 'case' at 40
/Library/Ruby/Gems/2.0.0/gems/simplecov-html-0.8.0/lib/simplecov-html.rb:58: warning: possibly useless use of a variable in void context
[Coveralls] Set up the SimpleCov formatter.
[Coveralls] Using SimpleCov's default settings.
Run options: --seed 6679

# Running tests:

.................................................................................................................

Finished tests in 0.094789s, 1192.1214 tests/s, 1951.7033 assertions/s.

113 tests, 185 assertions, 0 failures, 0 errors, 0 skips
[Coveralls] Outside the Travis environment, not sending data.

#####Uninstall: WARNING: This will completely destroy the vm so you likely want to ensure that you have pushed any and all code changes to GitHub beforehand.

In a terminal window on the host machine:

$ cd ~/work/tchart
$ vagrant destroy -f
$ cd ~
$ rm -r ~/work/tchart    # and possibly rm -r ~/work if it is now empty

#####Development Notes:

  • branch master contains the latest version of the application code. Older releases starting from 1.0.0 have their own branches; releases 0.0.1.pre and 0.0.1 have tags.

  • bin/tchart launches the application; it simply calls the program's main entry point, TChart::run (lib/tchart.rb).

  • ./_test will run all business/unit tests. Leave a terminal window open during development and run ./_test as you make changes to code.

  • ./_build will create the gem file tchart-1.0.1.gem

  • ./_install will install the gem locally.

  • If you wish to modify the Vagrantfile, it is best to do so on the host machine (~/work/tchart/Vagrantfile) so that you can easily do an edit/vagrant up/vagrant destroy cycle. Once you have finished making changes, vagrant up and then in a terminal window on the vm do something like:

    $ cd ~/Documents/tchart
    $ cp /vagrant/Vagrantfile .
    $ git status
    ...
    $ git add Vagrantfile
    $ git commit -S -m "Insert description of change to Vagrantfile here."
    ...
    $ git push
    ...
    

Thanks