diff --git a/README.rst b/README.rst index 2188693..c0432bb 100644 --- a/README.rst +++ b/README.rst @@ -63,7 +63,7 @@ You can install *atap_widgets* via pip_ from PyPI_: Standalone tools ------------- +---------------- Use the Concordancer as a standalone tool by clicking the following Binder link @@ -77,6 +77,12 @@ If you do not have access to any of the above accounts, you can use the below li .. image:: https://mybinder.org/badge_logo.svg :target: https://mybinder.org/v2/gh/Australian-Text-Analytics-Platform/atap_widgets/main?labpath=concordance_standalone.ipynb +Concordancer Tool User Guide +---------------------------- + +For instructions on how to use the Concordancer tool, please refer to the `Concordancer Tool User Guide`_. + + Development ------------ @@ -143,3 +149,4 @@ This project was generated from `@cjolowicz`_'s `Hypermodern Python Cookiecutter .. _Usage: https://atap_widgets.readthedocs.io/en/latest/usage.html .. _atap: https://www.atap.edu.au/ .. _CILogon troubleshooting guide: ./docs/cilogon-troubleshooting.pdf +.. _Concordancer Tool User Guide: ./docs/concordance_help_pages.pdf diff --git a/concordance_standalone.ipynb b/concordance_standalone.ipynb index 9d9c6e5..51c3112 100644 --- a/concordance_standalone.ipynb +++ b/concordance_standalone.ipynb @@ -55,7 +55,11 @@ "On how to use the notebook\n", "\n", "Briefly, to run a code cell navigate to the cell and then either click the 'play' button at the top or Ctrl+Enter (Cmd+Enter on Mac). The code block may take some time to run - an asterix `*` in the square brackets next to the block indicates the block is still processing. The asterix will transition into a number when the process is complete and the next block can be run.\n", - "" + "\n", + "\n", + "### Concordancer Tool User Guide\n", + "\n", + "For instructions on how to use the Concordancer tool, please refer to the [Concordancer Tool User Guide](docs/concordance_help_pages.pdf)." ] }, { diff --git a/docs/concordance_help_pages.pdf b/docs/concordance_help_pages.pdf new file mode 100644 index 0000000..4dc7b77 Binary files /dev/null and b/docs/concordance_help_pages.pdf differ