django-cities icon indicating copy to clipboard operation
django-cities copied to clipboard

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

Open YewoMhango opened this issue 2 years ago • 0 comments

Checklist

  • [x] I have verified that I am using a GIS-enabled database, such as PostGIS or Spatialite.
  • [x] I have verified that that issue exists against the master branch of django-cities.
  • [x] I have searched for similar issues in both open and closed tickets and cannot find a duplicate.
  • [x] 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

YewoMhango avatar Jan 06 '23 14:01 YewoMhango