From 2956cc7df8952ff95f4cefbff5c9bb3e58f40c7a Mon Sep 17 00:00:00 2001 From: Adrien Barbaresi Date: Thu, 23 Apr 2020 14:51:08 +0200 Subject: [PATCH] documentation update --- HISTORY.md | 7 ++++++- docs/installation.rst | 1 + docs/tutorial1.rst | 8 ++------ 3 files changed, 9 insertions(+), 7 deletions(-) diff --git a/HISTORY.md b/HISTORY.md index 2b5b3642..7447c179 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -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 diff --git a/docs/installation.rst b/docs/installation.rst index 546c3d6f..305f1bab 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -25,6 +25,7 @@ Installing Python packages ~~~~~~~~~~~~~~~~~~~~~~~~~~ - Straightforward: `Installing packages in python using pip `_ (& `official documentation `_) + - `Using pip on Windows `_ - Advanced: `Pipenv & Virtual Environments `_ diff --git a/docs/tutorial1.rst b/docs/tutorial1.rst index 35b182b4..a9d2aaa8 100644 --- a/docs/tutorial1.rst +++ b/docs/tutorial1.rst @@ -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 @@ -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 `_ (tutorial for Windows systems), `How to use the Terminal command line in macOS `_, or `An introduction to the Linux Terminal `_.