Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improvements to Installation documentation page #907

Closed
ifdattic opened this issue Apr 26, 2016 · 3 comments
Closed

Improvements to Installation documentation page #907

ifdattic opened this issue Apr 26, 2016 · 3 comments
Labels
Milestone

Comments

@ifdattic
Copy link
Contributor

In my opinion the installation page is a bit outdated and could be improved/simplified. Here are the changes I would suggest:

  • Remove the note about requiring PHP 5.3+. Or change because as far as I can tell the documentation is for the latest version and latest version requires at least 5.6
  • Remove Method Convert to PHP 5.3 #1 as only a single method is available
  • Replace composer install with simple "Run the composer require command ....."
  • Because examples in documentation use the bin/phpspec command add the section which tells how to change the bin directory and the documentation uses this directory. That by default the command would be at vendor/bin/phpspec
  • Instructions for installing composer itself (the link to its installation page) could be left as is.
@ciaranmcnulty ciaranmcnulty added this to the 3.0 milestone May 8, 2016
@ciaranmcnulty
Copy link
Member

I agree about PHP versions.
I agree about the #1.

I'm unsure about changing all the examples to vendor/bin/phpspec as I always set the bin-dir, but we could indeed update the install instructions to use composer commands rather than the JSON

@ifdattic
Copy link
Contributor Author

ifdattic commented May 8, 2016

Might have not translated in my comment, but personally myself I think it's not worth changing all examples to vendor/bin/phpspec. That I'm suggesting is just a adding a section explaining that it's possible to change the directory of the executable. If we want to get even fancier we can add that you can make a bash alias to just execute with phpspec :)

Sam-Burns added a commit to Sam-Burns/phpspec that referenced this issue May 17, 2016
Sam-Burns added a commit to Sam-Burns/phpspec that referenced this issue May 17, 2016
@Sam-Burns
Copy link
Contributor

Fixed in #919

Sam-Burns added a commit to Sam-Burns/phpspec that referenced this issue May 17, 2016
Sam-Burns added a commit to Sam-Burns/phpspec that referenced this issue May 19, 2016
Sam-Burns added a commit to Sam-Burns/phpspec that referenced this issue May 19, 2016
Sam-Burns added a commit to Sam-Burns/phpspec that referenced this issue May 22, 2016
Sam-Burns added a commit to Sam-Burns/phpspec that referenced this issue May 25, 2016
a-ast pushed a commit to a-ast/phpspec that referenced this issue Apr 6, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants