0.0
No commit activity in last 3 years
No release in over 3 years
bread-basket is still under development. This release contains only bare-bones functionality
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.9
~> 0.7
~> 2.12
~> 0.10
~> 0.2
~> 10.4
~> 3.2
~> 1.2

Runtime

~> 1.6
~> 2.0
~> 3.2
~> 0.19
 Project Readme

Basket

Build Status

Coverage Status

Code Climate

Basket is a tool for publishing scientific findings. It's the last piece of the 🍞 framework for scientific computing. But it's the first thing I've tried to build in that framework.

When the Poster module is finished it will make scientific posters. In the future however, bread-basket should help make figures, presentations, and maybe even full journal articles.

Installation and Usage

Since 🍞 hasn't been built (at all) yet, this little piece of the framework is pretty lonely. So for now it's just a command-line utility for making scientific posters. To use it, first get it into your Ruby environment with

$ gem install bread-basket

(If you're brand new to Ruby and not so sure about the above line, I plan to put an introduction to Ruby for scientists on the bread homepage. So just sit tight until I get that built.)

Once that's installed you should be able to convert a suitable markdown file (with your poster's content) and stylesheet into a nice pdf like so

$ bread-basket poster my-poster.md

and it will produce a pdf that you can take to the printers!

For more information on how to write the markdown file for your poster check out the example below, or email me. In the future a website will provide some good documentation.

Example

The samples folder contains an example poster lorem_flow.md along with the pdf this software creates. Right now this is the only sample that works so go check it out.

Contributing

  1. Fork it ( https://github.com/bread/bread-basket/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