From 2e05c9cb3d4970fc5a4aace6da658bf268f6a322 Mon Sep 17 00:00:00 2001
From: damjan <damjan@sgalinski.de>
Date: Tue, 1 Sep 2015 18:01:16 +0200
Subject: [PATCH] [TASK] Small fixes in readme
---
README.md | 31 ++++++++++++++++---------------
1 file changed, 16 insertions(+), 15 deletions(-)
diff --git a/README.md b/README.md
index b516c89..939b35a 100755
--- a/README.md
+++ b/README.md
@@ -4,7 +4,8 @@
SGalinski.TypoScriptReferenceFrontend is Flow package, so you need first a flow project:
-Use `composer create-project --dev --keep-vcs typo3/flow-base-distribution ProjectName`
+ composer create-project --dev --keep-vcs typo3/flow-base-distribution ProjectName
+
You can use any project name you wish. If you already have Flow project, you can skip this step.
## Install
@@ -13,17 +14,17 @@ The project can be installed by composer, or downloaded from git:
### A) Install by composer
-Change into `ProjectName` directory
+ TODO: Setup composer.json to install from git repository
- TODO: Setup composer.json to install from git repository
-
-Use `composer require ...` and `composer update` to install the package.
+ cd ProjectName
+ composer require ...
+ composer update
### B) Download from git
- cd Packages/Application
- git clone git@gitlab.sgalinski.de:typo3/TypoScript-Forger.git SGalinski.TypoScriptReferenceFrontend
- cd typo_script_backend
+ cd Packages/Application
+ git clone git@gitlab.sgalinski.de:typo3/TypoScript-Forger.git SGalinski.TypoScriptReferenceFrontend
+ cd typo_script_backend
## Supply the necessary routes
@@ -33,7 +34,7 @@ Edit Routes.yaml of your project (`ProjectName/Configuration/Routes.yaml`)
It is important to include SGalinski.TypoScriptReferenceFrontend subRoutes before WMDB.ForgerSubroutes to avoid
route conflicts.
-The prefix 'ts' in uriPattern: 'ts/<SGalinski.TypoScriptReferenceFrontend>' has purpose to avoid the conflict.
+The prefix `ts` in uriPattern: `ts/<SGalinski.TypoScriptReferenceFrontend>` has purpose to avoid the conflict.
<pre>
-
@@ -66,8 +67,6 @@ The prefix 'ts' in uriPattern: 'ts/<SGalinski.TypoScriptReferenceFrontend>' has
### In empty project Routes.yaml looks like this
-Uri prefix can be added if needed.
-
<pre>
-
name: 'TypoScriptReferenceFrontend'
@@ -90,14 +89,16 @@ Uri prefix can be added if needed.
package: TYPO3.Flow
</pre>
+Uri prefix can be added if needed.
+
## Configure view
-To be able to integrate SGalinski.TypoScriptReferenceFrontend package with other packages
+To be able to integrate `SGalinski.TypoScriptReferenceFrontend` package with other packages
(for example to use existing menu from other package), view configuration in main project is needed.
-Here is view configuration for integration with WMDB.Forger package.
+Here is view configuration for integration with `WMDB.Forger` package.
-ProjectName/Configuration/Views.yaml:
+`ProjectName/Configuration/Views.yaml`:
<pre>
-
@@ -119,4 +120,4 @@ All the data which is used by this package is provided by RESTful web service:
https://gitlab.sgalinski.de/typo3/TypoScript-Backend
-If the service is not installed, follow it's readme to do so.
+If the web service is not installed, follow it's readme to do so.
--
GitLab