Name: ofBook
Owner: openFrameworks
Description: openFrameworks community book
Created: 2014-01-20 08:52:20.0
Updated: 2018-01-18 13:12:13.0
Pushed: 2018-01-15 03:01:00.0
Homepage: null
Size: 125133
Language: C++
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
this is a collaboratively written openFrameworks book.
Read the latest version here!
for other language, please read below.
please note that this is still work-in-progress
Dependencies
Scripts for building the web and pdf versions of the book are in scripts/
directory: createWebBook.py
and createPDFBook.py
. You must run them from the scripts/
directory, so either double-click the script or run it from command line.
output/webBook
directory. Opening up output/webBook/index.html
will open up the table of contents.output/ofBook.pdf
. output/ofBook.tex
is also created, for debugging purposes.`sudo easy_install pip
`pip install -r requirements.txt
C:/PythonXX/Scripts
. To access it from command line, you will need to add the location of your Scripts
folder to your path variable (see this guide).pip install -r requirements.txt
from the command line (inside of the ofBook/ directory) to install the dependencies.`sudo apt-get install python-pip python2.7-dev git pandoc ruby-sass texlive
`pip install -r requirements.txt
In addition to the python routines to build the book, there is also an optional gulp file for use in style development. It requires gulp, browser-sync and gulp sass and can be used primarily to see changes to CSS reflect live on the static pages. You have to run the python createWebBook script first.
Since git is at the heart of the management of this endeavour, please check the git best practices. If you do not agree with all of them, please at least stick to the “Do commit early and often” paradigm. This will make doing reviews, picking the good stuff from your contributions and polishing the rest a lot easier. Github itself also offers a lot of help on common issues. So sign up, fork the repo and send your pull requests along our way.
openFrameworks Book discussion.
Older Book discussions can be checked at ofBook Archives