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

Add Click to Readme #1157

Closed
Siecje opened this issue Aug 26, 2014 · 11 comments
Closed

Add Click to Readme #1157

Siecje opened this issue Aug 26, 2014 · 11 comments
Milestone

Comments

@Siecje
Copy link
Contributor

Siecje commented Aug 26, 2014

Under What do I need? click should also be listed.

@untitaker
Copy link
Contributor

I vote for removing the whole section, it duplicates information found in setup.py.

@alxngyn
Copy link

alxngyn commented Sep 13, 2014

Is Click needed?
I just installed flask without needing click.

@untitaker
Copy link
Contributor

It will be required for 1.0

@untitaker
Copy link
Contributor

Does anybody object against removing the first sentence of that section and rephrase it to the following:

~ What do I need?

  `pip` or `easy_install` will install the dependencies for you if you do
  `pip install Flask`.  I encourage you to use a virtualenv.  Check the
  docs for complete installation and usage instructions.

@MikeiLL
Copy link

MikeiLL commented Sep 17, 2014

pip install Flask did not install click in virtualenvwrapper on OS X

@docapotamus
Copy link

@MikeiLL It will be installing 0.10.1 from PyPI not 1.0

@MikeiLL
Copy link

MikeiLL commented Sep 17, 2014

very cool.

On Sep 17, 2014, at 12:52 AM, Joe Doherty wrote:

@MikeiLL It will be installing 0.10.1 from PyPI not 1.0


Reply to this email directly or view it on GitHub.

@brunsgaard
Copy link

@untitaker I agree, the information is redundant as it is (and should be) specified in the install_requires in the setup.py.

I have another proposal though, what about reworking/rewriting the whole README. At this point of writing the README seems a bit insufficient for a project of the size of flask. Also I will suggest to change the format to .rst, this way it will be compliant the requirements for sdist's and also offer more readability on github.

I would be glad to start a new issue and come up with a draft to an improvement, what do you guys think about this idea?

@untitaker
Copy link
Contributor

Armin said once the reason he prefers plaintext READMEs is because

  • they prevent you from writing READMEs that are not very readable in a text editor
  • they prevent you from writing too long READMEs
  • .rst is a weird file extension that might be unfamiliar to some packagers or users. "README" alone is more standard.

I can agree with that, but this also makes embedding Travis badges impossible, which i consider important, see https://github.com/pocoo/metaflask/issues/59. For Werkzeug, we still made it a rst file, but nevertheless i don't think any additional content would be accepted.

@brunsgaard
Copy link

@untitaker okay, thanks for taking it up though..

@untitaker
Copy link
Contributor

That said, i don't see a reason why the README couldn't be rst. You'll have to negotiate this with Armin directly, he's the one who has a strong opinion on this. (Best reachable through IRC)

@untitaker untitaker modified the milestone: 1.0 Oct 19, 2014
andyxning pushed a commit to andyxning/flask that referenced this issue Apr 19, 2015
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 14, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

6 participants