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

Installation instructions don't specify whether to follow all or just one of the three listed methods #236

Open
4 of 5 tasks
YewoMhango opened this issue Jan 6, 2023 · 0 comments

Comments

@YewoMhango
Copy link

Checklist

  • I have verified that I am using a GIS-enabled database, such as PostGIS or Spatialite.
  • I have verified that that issue exists against the master branch of django-cities.
  • I have searched for similar issues in both open and closed tickets and cannot find a duplicate.
  • I have reduced the issue to the simplest possible case.
  • I have included a failing test as a pull request. (If you are unable to do so we can still accept the issue.)

Steps to reproduce

Visit https://github.com/coderholic/django-cities#installation . There are listed three ways of installing the library, i.e., using git clone, wget+unzip, and pip

Expected behavior

The documentation should specify whether we are supposed to run all the three steps in order, or whether we should just choose one of them. (i.e., by saying something like "Choose only one of the three installation methods below")

Actual behavior

When I wanted to install django-cities, I started by following the git clone ... and wget ... steps before realizing that they're all do the same thing

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

No branches or pull requests

1 participant