Skip to content

Conversation

@mehov
Copy link

@mehov mehov commented Oct 18, 2016

Description

Made it obvious one has to cd into their CakePHP directory and run the composer command from it.

Summarize

Edited README.md

@codecov-io
Copy link

codecov-io commented Oct 18, 2016

Current coverage is 96.11% (diff: 100%)

Merging #164 into master will not change coverage

@@             master       #164   diff @@
==========================================
  Files            12         12          
  Lines           335        335          
  Methods          37         37          
  Messages          0          0          
  Branches          0          0          
==========================================
  Hits            322        322          
  Misses           13         13          
  Partials          0          0          

Powered by Codecov. Last update 8da53d6...fa6a040

README.md Outdated
## Installing Using [Composer][composer]

Using [Composer][composer]:
`cd` to your CakePHP directory and run the following command:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why cakephp dir?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah "your app" or "your project" directory would be more appropriate.

@dereuromark
Copy link
Member

I am not a too big fan of this, as it should be very clear when working with composer where to be for it to run (where the composer.json file is, so in the app dir).
This seems to be redundant and clear from the scope.

But meh, if it helps some people..

@mehov
Copy link
Author

mehov commented Oct 18, 2016

But meh, if it helps some people..

My thoughts exactly. There's a chance someone will stop for a second and be uncertain about that. Not everyone has as much experience with composer as you do for instance. I'm unsure what exactly is wrong with saying "your CakePHP directory", but if you feel it's not okay then so be it. Rephrased that portion using what you said, that would make it more helpful.

@dereuromark
Copy link
Member

CakePHP dir = core dir (vendor/cakephp/cakephp) = dangerous tip.
My remark wasn't about rephrasing, I was just not sure this additional note is necessary.

@mehov
Copy link
Author

mehov commented Oct 18, 2016

CakePHP dir = core dir (vendor/cakephp/cakephp) = dangerous tip.

I see what you're saying. Sorry about that then.

@josegonzalez josegonzalez merged commit aebc479 into FriendsOfCake:master Jan 2, 2017
@josegonzalez josegonzalez changed the title A tiny change to README.md#Installing Clarify installation docs Jan 2, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants