Skip to content

Commit

Permalink
Merge pull request #342 from kdambekalns/adjust-readme-for-32
Browse files Browse the repository at this point in the history
TASK: Update Readme.rst and Upgrading.rst for 3.2 branch
  • Loading branch information
kdambekalns committed May 4, 2016
2 parents 0091fd9 + b49997c commit 1f94318
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 9 deletions.
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
--------------
TYPO3 Flow 3.x
--------------
------------------
Flow Framework 3.2
------------------

Welcome to Flow!

There are a few things you need to know to get started.
All necessary steps are explained in the `Getting Started tutorial <http://flowframework.readthedocs.org/en/stable/Quickstart/index.html>`_.
All necessary steps are explained in the `Getting Started tutorial <http://flowframework.readthedocs.io/en/3.2/Quickstart/index.html>`_.

In short here's what you need to do:

Expand All @@ -17,4 +17,4 @@ In short here's what you need to do:
your system environment!).
3) Call the URL leading to your virtual host from a browser

Have fun!
Have fun!
Original file line number Diff line number Diff line change
@@ -1,13 +1,20 @@
Upgrading instructions
======================

This file contains instructions for upgrading your Flow 3.x based
applications to TYPO3 Flow 3.y.
This file contains instructions for upgrading your Flow 3.1 based
applications to Flow 3.2.

What has changed
----------------

TBD
There haven’t been API changes in Flow 3.2 which require your code to be adjusted. But the package management has
been refactored. This change is considered breaking due to the following:

- New packages are only automatically picked up if they were installed via composer or created through the Flow package management. In all other cases you need to run the: package:rescan command to pick new package up.
- Some @api classes and methods were deprecated and will be removed or changed in the next major Flow version.
- Some newly added methods of PackageManager and Package are used in the Flow core now, so if someone would reimplement both according to interface it would not work with Flow, but that is already the case without this change, so it shouldn’t be an issue.

A more detailed overview of what is new can be found in the `3.2 release notes <http://flowframework.readthedocs.io/en/3.2/TheDefinitiveGuide/PartV/ReleaseNotes/320.html>`_.

Upgrading your Packages
-----------------------
Expand Down Expand Up @@ -79,4 +86,4 @@ That should result in a working package.

If it does not and you have no idea what to do next, please get in touch
with us. The `support page <http://flow.typo3.org/support/>`_ provides more
information.
information.

0 comments on commit 1f94318

Please sign in to comment.