Permalink
Browse files

Split developer documentation to seperate file

  • Loading branch information...
1 parent 38982a8 commit 58632cb6453128800e210a45652f08cce09a928a @FooBarWidget FooBarWidget committed Mar 19, 2008
Showing with 56 additions and 52 deletions.
  1. +52 −0 DEVELOPERS.TXT
  2. +1 −51 README
  3. +3 −1 Rakefile
View
@@ -0,0 +1,52 @@
+= Developers information
+
+== Required software
+
+The tests need the following software installed:
+
+* All the usual Passenger dependencies.
+* Ruby on Rails >= 2.0.1
+* rspec >= 1.1.2
+* mime-types >= 1.15
+
+The following software is optional:
+
+* RDoc, for generating HTML Ruby API documentation
+* Doxygen, for generating HTML C++ API documentation
+* dot (part of Graphviz), for generating diagrams in HTML API documentation
+* The font "Bitstream Vera Sans", used in the class diagrams. See http://www.gnome.org/fonts
+* AsciiDoc >= 8.2.5, for converting various doc/*.txt documents to HTML
+
+== Compiling Passenger
+
+Run the following command to compile everything:
+
+ rake
+
+== Tests
+
+Run all tests:
+
+ rake
+
+Run just the tests for the Apache 2 module:
+
+ rake test:apache2
+
+Run just the unit tests for the Ruby spawn server:
+
+ rake test:ruby
+
+Run just the integration tests:
+
+ rake test:integration
+
+*Note*: some tests, such as the ones that test privilege lowering, require
+root privileges. Those will only be run if Rake is run as root.
+
+== Documentation
+
+Various developer documents can be found in 'doc/*.html'.
+
+The Ruby part's API reference is located in 'doc/rdoc/'.
+The C++ part's API reference is located in 'doc/cxxapi/'.
View
@@ -90,60 +90,10 @@ public.
== Installation
-=== Supported configurations
-
-* Apache 2.x with the prefork MPM
-
-Other MPMs have not been tested (yet). Apache 1 is not supported at the moment.
-
-=== Installation instructions
-
Run the following script as root:
./bin/passenger-install-apache2-module
-That's it. :) For detailed instructions and troubleshooting, please read the
+That's it. :) For troubleshooting, configuration and tips, please read the
file 'doc/Users guide.html'.
-
-== Developers
-
-=== Requirements
-
-Developers who wish to modify or to contribute to Passenger will need to have
-the following software installed:
-
-* Ruby and RubyGems
-* Ruby on Rails >= 1.2.0. At least version 2.0.1 is required to run the
- test suit.
-* The GNU C++ compiler (g++)
-* Apache 2 and APR, including development headers
-* rake >= 0.8.1
-* fastthread >= 1.0.1
-* rspec >= 1.1.2, for the Ruby unit tests
-* mime-types >= 1.15, for the integration tests
-
-The following software is optional:
-
-* RDoc, for generating HTML Ruby API documentation
-* Doxygen, for generating HTML C++ API documentation
-* dot (part of Graphviz), for generating diagrams in HTML API documentation
-* The font "Bitstream Vera Sans", used in the class diagrams. See http://www.gnome.org/fonts
-* AsciiDoc >= 8.2.5, for converting various doc/*.txt documents to HTML
-
-=== Compilation, unit tests and other tasks
-
-To compile Passenger, run the following command:
-
- rake
-
-To run the unit tests, run the following command:
-
- rake test
-
-*Note*: some tests, such as the ones that test privilege lowering, require
-root privileges. Those will only be run if the test suit is run as root.
-
-For a full list of Rake tasks, run:
-
- rake -T
View
@@ -277,7 +277,8 @@ end
Rake::RDocTask.new do |rd|
rd.main = "README"
rd.rdoc_dir = "doc/rdoc"
- rd.rdoc_files.include("README", "lib/passenger/*.rb", "lib/rake/extensions.rb", "ext/passenger/*.c")
+ rd.rdoc_files.include("README", "DEVELOPERS.TXT",
+ "lib/passenger/*.rb", "lib/rake/extensions.rb", "ext/passenger/*.c")
rd.template = "./doc/template/horo"
rd.title = "Passenger Ruby API"
rd.options << "-S" << "-N" << "-p" << "-H"
@@ -302,6 +303,7 @@ spec = Gem::Specification.new do |s|
s.files = FileList[
'Rakefile',
'README',
+ 'DEVELOPERS.TXT',
'LICENSE',
'lib/**/*.rb',
'lib/passenger/templates/*',

0 comments on commit 58632cb

Please sign in to comment.