Skip to content

Commit

Permalink
Added Concordancer user guide and included reference within README an…
Browse files Browse the repository at this point in the history
…d notebook
  • Loading branch information
Hamish Croser committed Apr 1, 2024
1 parent 1bcd017 commit bb3401f
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 2 deletions.
9 changes: 8 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
------------

Expand Down Expand Up @@ -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
6 changes: 5 additions & 1 deletion concordance_standalone.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,11 @@
"<b>On how to use the notebook</b>\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",
"</div>"
"</div>\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)."
]
},
{
Expand Down
Binary file added docs/concordance_help_pages.pdf
Binary file not shown.

0 comments on commit bb3401f

Please # to comment.