Changeset 16

Timestamp:

02/11/08 18:57:11 (4 years ago)

Author:

dom

Message:

Minimal README files for new setup

Location:

trunk

Files:

• README (modified) (3 diffs)
• src/README (added)

trunk/README

@@ -1 +1 @@
 EXTREME FORGE
 
-http://www.extremeforge.net
+http://extremeforge.net
 
 The aims of this software are:
@@ -19 +19 @@
 
 Erlang/OTP R11B4 or above.
+Cf. http://www.erlang.org
 
 Installation
@@ -24 +25 @@
 
 Download the tarball, unpack to any convenient location.
-Change to the ./ebin subdirectory, then
-start an erlang shell in distributed mode, e.g.:
+Change to the directory to which you unpacked.
+From the shell, run the 'install' escript:
 
-% erl -sname forge
+% ./install
 
-Then, from the erlang shell prompt, first compile:
-
-1> make:all().
-
-then run the tests to ensure that Extreme Forge is working on your platform:
-
-2> xpdojo:test_files("..").
-
-After some output (including process crashes, they are part of the
-testing process), you should get a last line of output like this:
-
-[{acceptance,39,39},{unit,101,101},{modules,27,27}]
-
-This means that all unit and acceptance tests have passed. If the
-two numbers following each phase (modules, unit, acceptance) are
-different from each other, some things are not working as expected.
-
-Using
------
-
-You can now test any source tree of your own in the same way:
-
-3> xpdojo:test_files("/some/path/to/source").
-
-Or, for a more interesting experience, run the continuous testing
-server, e.g.:
-
-4> Pids = testing_server:start("/some/path/to/source", "/tmp/log.txt").
-
-Then, "tail -f /tmp/log.txt" from shell or an emacs compilation buffer
-to view the output.
-
-To stop the testing_server:
-
-5> testing_server:stop(Pids).
-
-Read src/test_files_acceptance.erl for more details (such as
-defining your own rules for detecting unit and acceptance tests).
+This should print out some lines, ending with "done".
 
 LEGAL MATTERS
 -------------
 
-The software contained herein is:
-
-Copyright (c) 2004-2007 Dominic Williams, Nicolas Charpentier,
-Fabrice Nourisson, Jacques Couvreur, Virgile Delecolle.
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are
-met:
-
-* Redistributions of source code must retain the above copyright
-  notice, this list of conditions and the following disclaimer.
-* Redistributions in binary form must reproduce the above copyright
-  notice, this list of conditions and the following disclaimer in the
-  documentation and/or other materials provided with the distribution.
-* The names of the authors may not be used to endorse or promote
-  products derived from this software without specific prior written
-  permission.
-
-THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR
-IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT,
-INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
-STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
-IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGE.
+See the file COPYING located in the src directory.