Skip to content

Commit

Permalink
- adapted README.md to install and use with Composer from fit-skeleton,
Browse files Browse the repository at this point in the history
  extracting doc/ConfigManually.md, increased PHP version requirement
increased to 5.1 because PHPFIT requires it
  replaced instructions for manual install and usage by reference to
original README.md in doc,
  added reference for Mixed Data Typing with
PHPFIT_TypeAdapter_PhpTolerant,
  added security warnings.
- lowered PHP version requirement in composer.json to 5.1 (after
testing)
- added script/run-cli.php for running from the command line
- adapted script/config_shelf.php to support run-cli.php
- added ChangeLog.md
  • Loading branch information
metaclass-nl committed Aug 23, 2013
1 parent 5966ccd commit d6774f1
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 9 deletions.
32 changes: 23 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
Fit Shelf for PHPFIT
====================

INTRODUCTION
============
------------

Fit Shelf is a reimplementation in PHP of the functionality of Fit Library as described in
the book "Fit for developing Software" of Rick Mugridge and Ward Cunningham,
Expand All @@ -12,8 +15,19 @@ would have taken too much work. With only 63.5 KB in PHP source files[1] Fit She
much simpeler. As its name suggest is does not pretend to be a complete library,
but rather a small shelf. But easyer to understand, use and port. And written in PHP!


SECURITY
--------

Do not install in a production environment.

WARNING: Fit Shelf allows tests to access arbitrary properties and methods on the object under test.
It has no notion of authorization. Allowing end users to run self-modified tests may expose sensitive
data, cause fatal errors and leave the system in an undefined state.


INSTALLATION AND CONFIGURATION
==============================
------------------------------

- *With Composer and Shelf*

Expand All @@ -26,7 +40,7 @@ INSTALLATION AND CONFIGURATION
Requires PHP >= 5.1.

SPECIAL FEATURES
================
----------------

1. Mixed data typing

Expand Down Expand Up @@ -104,7 +118,7 @@ SPECIAL FEATURES
datatypes of phpPeanuts are supported.

RELEASE NOTES
=============
-------------

Version 0.1 (beta 1) has been tested sucessfully with the tests and fixtures of the
Historical Data Management (HDM) extension to the PhpPeanuts framework.
Expand All @@ -126,19 +140,19 @@ Some smaller refactorings may be made with respect to reoccurring code.


SUPPORT (Dutch)
===============
---------------

MetaClass biedt hulp en ondersteuning binnen Nederland bij onderhoud
en ontwikkeling van software, tests en fixtures.
Voor meer informatie kijk op http://www.metaclass.nl/


COPYRIGHT AND LICENCE
=====================
---------------------

Courtesy to Rick Mugridge, http://www.RimuResearch.com for the
functional specification of Fit Library (http://sourceforge.net/projects/fitlibrary/)
and the ideas behind it to which MetaClass claims no rights.
Courtesy to Rick Mugridge for the functional specification of Fit Library
(http://sourceforge.net/projects/fitlibrary/) and the ideas behind it
to which MetaClass claims no rights.

This implementation (Fit Shelf) is Copyright (c) 2010-2012 H. Verhoeven Beheer BV,
holding of MetaClass Groningen Nederland.
Expand Down
19 changes: 19 additions & 0 deletions doc/ChangeLog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
0.3
---
- added composer.json
- adapted README.md to install and use with Composer from fit-skeleton,
extracting doc/ConfigManually.md
- PHP version requirement increased to 5.1 because of PHPFIT requires it
- added script/run-cli.php for running from the command line
- adapted script/config_shelf.php to support run-cli.php
- added ChangeLog.md

0.2 (tagged 1.0.beta2)
----------------------
- added more book fixtures and tests
- adapted to PhpFit clone on github.com/metaclass-nl/phpfit

0.1 (tagged 1.0.beta1)
----------------------
- comitted 1.0.beta1 release from www.metaclass.nl (please ignore this version number)
- ReadMe.txt renamed to README.md and script.conf_shelf.php adapted for testing

0 comments on commit d6774f1

Please sign in to comment.