Skip to content

Commit 1c91a80

Browse files
committed
adopt documentation to use terser
1 parent 7bb2640 commit 1c91a80

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@ https://github.com/jrief/django-admin-sortable2
3535

3636
Detailled documentation can be found on [ReadTheDocs](https://django-admin-sortable2.readthedocs.org/en/latest/).
3737

38-
To ask questions or reporting bugs, please read the [contributor's guide](https://django-admin-sortable2.readthedocs.io/en/latest/contributing.html).
38+
Before reporting bugs or asking questions, please read the
39+
[contributor's guide](https://django-admin-sortable2.readthedocs.io/en/latest/contributing.html).
3940

4041

4142
## License

docs/source/contributing.rst

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,9 @@ compiler:
2727
cd django-admin-sortable2
2828
npm install --also=dev
2929
npm run build
30+
3031
# and optionally for a minimized version
31-
npm run uglify
32+
npm run minify
3233
3334
This then builds and bundles the JavaScript file
3435
``adminsortable2/static/adminsortable2/js/adminsortable2.js`` which later on is imported by the
@@ -45,23 +46,26 @@ Run the Demo App
4546
**django-admin-sotable2** is shipped with a demo app, which shall be used as a reference when
4647
reporting bugs, proposing new features or to just get a quick first impression of this library.
4748

48-
Follow these steps to run this demo app.
49+
Follow these steps to run this demo app. Note that in addition to Python, you also need a recent
50+
version of NodeJS.
4951

5052
.. code:: bash
5153
5254
git clone https://github.com/jrief/django-admin-sortable2.git
5355
cd django-admin-sortable2
54-
npm install --also=dev
56+
npm install --include=dev
5557
npm run build
56-
npm run uglify
58+
npm run minify
5759
python -m pip install Django
5860
python -m pip install -r testapp/requirements.txt
61+
5962
# we use the default template files and patch them, rather than using our own modified one
6063
django_version=$(python -c 'from django import VERSION; print("{0}.{1}".format(*VERSION))')
6164
curl --silent --output adminsortable2/templates/adminsortable2/edit_inline/stacked-django-$django_version.html https://raw.githubusercontent.com/django/django/stable/$django_version.x/django/contrib/admin/templates/admin/edit_inline/stacked.html
6265
curl --silent --output adminsortable2/templates/adminsortable2/edit_inline/tabular-django-$django_version.html https://raw.githubusercontent.com/django/django/stable/$django_version.x/django/contrib/admin/templates/admin/edit_inline/tabular.html
6366
patch -p0 adminsortable2/templates/adminsortable2/edit_inline/stacked-django-$django_version.html patches/stacked-django-4.0.patch
6467
patch -p0 adminsortable2/templates/adminsortable2/edit_inline/tabular-django-$django_version.html patches/tabular-django-4.0.patch
68+
6569
cd testapp
6670
./manage.py migrate
6771
./manage.py loaddata fixtures/data.json

0 commit comments

Comments
 (0)