Skip to content

Commit

Permalink
documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
adbar committed Apr 23, 2020
1 parent 67d65ae commit 2956cc7
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 7 deletions.
7 changes: 6 additions & 1 deletion HISTORY.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
## History / Changelog


### 0.4
### 0.4.1
- better metadata extraction and integration (XML & XML-TEI)
- more efficient processing
- output directory as CLI-option


### 0.4
- improved "fast" mode (accuracy and speed)
- better fallbacks with readability-lxml and justext
- metadata extraction added
Expand Down
1 change: 1 addition & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Installing Python packages
~~~~~~~~~~~~~~~~~~~~~~~~~~

- Straightforward: `Installing packages in python using pip <https://thepythonguru.com/installing-packages-in-python-using-pip/>`_ (& `official documentation <https://pip.pypa.io/en/stable/>`_)
- `Using pip on Windows <https://projects.raspberrypi.org/en/projects/using-pip-on-windows/2>`_
- Advanced: `Pipenv & Virtual Environments <https://docs.python-guide.org/dev/virtualenvs/>`_


Expand Down
8 changes: 2 additions & 6 deletions docs/tutorial1.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Tutorial: from a list of links to a vocabulary list
===================================================
Tutorial: from a list of links to a frequency list
==================================================


Get your system up and running
Expand All @@ -9,10 +9,6 @@ Get your system up and running
- Making sure you have the latest version: ``pip install -U trafilatura``
- Additional software for this tutorial: ``pip install -U SoMaJo``

*Temporary advice: parts of this tutorial require a cutting-edge version of the software which can be installed straight from the software repository:*

``pip install -U git+https://github.com/adbar/trafilatura.git``

The following consists of command-line instructions. For general information see `Comment Prompt <https://www.lifewire.com/how-to-open-command-prompt-2618089>`_ (tutorial for Windows systems), `How to use the Terminal command line in macOS <https://macpaw.com/how-to/use-terminal-on-mac>`_, or `An introduction to the Linux Terminal <https://www.digitalocean.com/community/tutorials/an-introduction-to-the-linux-terminal>`_.


Expand Down

0 comments on commit 2956cc7

Please sign in to comment.