Permalink
Browse files

updated gem config + postinstall

  • Loading branch information...
1 parent 9544c63 commit 4a41401072dcb56fd856be715bb6c4393b136b8e @drnic drnic committed May 18, 2008
Showing with 33 additions and 13 deletions.
  1. +4 −6 PostInstall.txt
  2. +24 −3 README.markdown
  3. +5 −4 config/hoe.rb
View
@@ -1,7 +1,5 @@
-For more information on codex, see http://codex.rubyforge.org
-
-NOTE: Change this information in PostInstall.txt
-You can also delete it if you don't want it.
-
-
+To create new presentations:
+
+ codex path/to/presentation/folder
+
View
@@ -1,3 +1,11 @@
+Codex
+-----
+
+http://github.com/pragdave/codex
+
+Description
+===========
+
This is a remarkably trivial package that makes simply HTML-based presentations from
a set up source files written using Textile. It's designed to help when creating
slides that contain lots of code, as it allows code to be embedded from external source files.
@@ -6,12 +14,25 @@ This means that the code that you embed can come from running (and tested) progr
The code in the resulting slides is syntax highlighted, and is hyperlinked to the original
source file, allowing that file to be brought up in Textmate.
-To get started
+Requirements
+============
+
+* make sure you have Ruby 1.8.6 installed and RubyGems
+, along with the Rake and redcloth gems
+
+Installation
+============
+
+ gem install codex
+
+Usage
+=====
-* make sure you have Ruby 1.8.6 installed, along with the Rake and redcloth gems
* type 'rake all' in the same directory as this README file
* open html/all.html
+License
+=======
-See the file LICENSE for details on how this all may be used.
+See the file LICENSE.txt for details on how this all may be used.
View
@@ -1,14 +1,15 @@
require 'codex/version'
-AUTHOR = 'Dr Nic Williams' # can also be an array of Authors
-EMAIL = "drnicwilliams@gmail.com"
-DESCRIPTION = "description of gem"
+AUTHOR = 'Dave Thomas' # can also be an array of Authors
+EMAIL = "dave@pragprog.com"
+DESCRIPTION = "Simple tool for creating source-code intensive presentations and courses"
GEM_NAME = 'codex' # what ppl will type to install your gem
RUBYFORGE_PROJECT = 'codex' # The unix name for your project
HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
EXTRA_DEPENDENCIES = [
-# ['activesupport', '>= 1.3.1']
+ ['rake', '>= 0.8.1'],
+ ['RedCloth', '>= 3.0.4']
] # An array of rubygem dependencies [name, version]
@config_file = "~/.rubyforge/user-config.yml"

0 comments on commit 4a41401

Please sign in to comment.