Skip to content

Commit 8d9fc71

Browse files
committed
TASK: Adopt documentation
1 parent 8566e13 commit 8d9fc71

1 file changed

Lines changed: 12 additions & 10 deletions

File tree

‎README.md‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@ Right now we focus especially on rules to migrate from the old Content Repositor
66
Event Sourced Content Repository (>= 9.0).
77

88
## Installation
9-
As Rector has strict dependency requirements, which might not match your own project, we strongly recommend to install
10-
neos/rector in a dedicated directory and **not to add it to your project**.
9+
10+
Please install the neos/rector package in your Distribution as a dev dependency with composer.
11+
<br>(This has changed to previous versions of this package)
1112

1213
```bash
1314
# inside your Distribution folder
@@ -22,9 +23,11 @@ migrated). By default, all of `./DistributionPackages` will be migrated.
2223

2324
Right now, we ship the following sets of Rector rules:
2425

25-
- `\Neos\Rector\NeosRectorSets::CONTENTREPOSITORY_9_0`: all rules needed to migrate to the Event-Sourced Content Repository
26+
- `\Neos\Rector\NeosRectorSets::CONTENTREPOSITORY_9_0`: all rules needed to migrate to the Event-Sourced Content
27+
Repository
2628

27-
Also you need to add the autoload paths, to allow rector to parse your code properly. By default we added `./Packages` and `./DistributionPackages` to the template.
29+
Also you need to add the autoload paths, to allow rector to parse your code properly. By default we added `./Packages`
30+
and `./DistributionPackages` to the template.
2831

2932
```php
3033
$rectorConfig->sets([
@@ -50,11 +53,12 @@ Run the following command at the root of your distribution (i.e. where `rector.p
5053

5154
```bash
5255
# for trying out what would be done
53-
./rector/vendor/bin/rector --dry-run
56+
./bin/rector --dry-run
5457

5558
# for running the migrations
56-
./rector/vendor/bin/rector
59+
./bin/rector
5760
```
61+
5862
---
5963

6064
# Developing Rector Rules for Neos
@@ -75,15 +79,13 @@ The test setup runs completely self contained; does not need *any* Distribution
7579

7680
```bash
7781
# if inside a Neos Distribution, change to the Package's folder
78-
cd rector
82+
cd Packages/Libraries/neos/rector
7983

8084
# install PHPunit
8185
composer install
8286

8387
# run PHPUnit
84-
composer test
85-
```
86-
88+
composer tests
8789
```
8890

8991
## Generating docs

0 commit comments

Comments
 (0)