Skip to content

Commit

Permalink
Add doxygen dependency notes to Rakefile
Browse files Browse the repository at this point in the history
  • Loading branch information
4-20ma committed Sep 12, 2016
1 parent e228bed commit 58612e8
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ require 'rubygems'
require 'rake/version_task' # gem install version
require 'version'

# requires additional packages on MacOS (including Homebrew):
# $ /usr/bin/ruby -e "$(curl -fsSL \
# https://raw.githubusercontent.com/Homebrew/install/master/install)"
# $ brew install doxygen # generates documentation from source code
# $ brew cask install mactex # MacTeX

Rake::VersionTask.new do |task|
# prevent auto-commit on version bump
task.with_git = false
Expand Down Expand Up @@ -53,11 +59,11 @@ task :info do
$ rake version:bump:major # or
edit 'VERSION' file directly
- Prepare release date, 'HISTORY.md' file, documentation:
- Prepare release date, 'CHANGELOG.md' file, documentation:
$ rake prepare
- Review changes to 'HISTORY.md' file
- Review changes to 'CHANGELOG.md' file
This file is assembled using git commit messages; review for completeness.
- Review html documentation files
Expand Down

0 comments on commit 58612e8

Please sign in to comment.