Commit a8007424 authored by Vojtěch Sobota's avatar Vojtěch Sobota

Update README.md with regard to migration to PHP 7.2 and update version to 0.2.0, closes #31

parent 7d582f2b
Pipeline #37037056 passed with stage
in 53 seconds
# Changelog
## [0.2.0] - 2018-11-18
### Changed
- Migrate from PHP 5.6 to PHP 7.2.
## [0.1.2] - 2018-10-31
### Changed
- Throw the correct exception when the `VTCompose\String\String::substring()` method fails.
......
......@@ -4,7 +4,7 @@ vtCompose
Synopsis
--------
vtCompose is a low-level PHP framework which wraps around PHP programming API providing more coherent and
vtCompose is a low-level PHP framework which wraps around the PHP programming API providing more coherent and
object oriented API.
Code Example
......@@ -78,10 +78,7 @@ Installation
### Prerequisites
Currently there is no PHP 7 compatible version of vtCompose. The only supported PHP version is 5.6. This
however might change in future. (Perhaps the most significant reason for the incompatibility is the
`VTCompose\String` namespace and the `String` class inside this namespace. As of PHP 7 `string` is a reserved
word and cannot be used as a class or namespace name.)
The supported PHP version is 7.2 however vtCompose should also work with PHP 7.0 and 7.1.
Depending on which features of vtCompose you use there will be a set of required PHP extensions. The complete
list of PHP extensions vtCompose might currently require is as follows:
......@@ -129,11 +126,11 @@ in any environment capable of running PHP.
1. Download a ZIP file with the required version of vtCompose from [the project
page](http://www.voj-tech.net/vtcompose/).
wget http://www.voj-tech.net/data/content/projects/vtcompose-0.1.2.zip
wget http://www.voj-tech.net/data/content/projects/vtcompose-0.2.0.zip
2. Unpack the downloaded file.
unzip vtcompose-0.1.2.zip
unzip vtcompose-0.2.0.zip
3. Optionally remove files or directories from within the `php/VTCompose` directory which contains vtCompose
classes. You can do this if you do not want to install the complete vtCompose framework but instead you
......@@ -144,7 +141,7 @@ in any environment capable of running PHP.
the `include_path` directive for this purpose. Make sure this is done as a user account allowed to write to
the destination directory.
cp -R vtcompose-0.1.2/php/VTCompose /usr/local/share/vtcompose/php
cp -R vtcompose-0.2.0/php/VTCompose /usr/local/share/vtcompose/php
API Reference
-------------
......@@ -167,7 +164,7 @@ are then explained on examples on the following pages:
handling routines if desired.
- **[Friend Classes](http://www.voj-tech.net/vtcompose/friend-classes/):** Rather than a functional feature
this article describes how vtCompose solves the lack of the concept of a friend class or an
internal/library-scoped accessibility of methods in PHP 5.6.
internal/library-scoped accessibility of methods in PHP 7.2.
vtCompose currently produces all output encoded in UTF-8. Similarly it assumes any input is encoded in UTF-8.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment