From 91742ed9459d9018b4b59b0460f4d7d6b3c5caf2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Allan=20Nordh=C3=B8y?= Date: Fri, 7 Feb 2020 17:46:04 +0100 Subject: [PATCH] YaCy packages README reworked --- yacy-packages.readme | 60 +++++++++++++++++++++----------------------- 1 file changed, 29 insertions(+), 31 deletions(-) diff --git a/yacy-packages.readme b/yacy-packages.readme index a5656337b..a4156e33c 100644 --- a/yacy-packages.readme +++ b/yacy-packages.readme @@ -1,69 +1,67 @@ -The YaCy Search Application is build on a set of packages -for efficient IO, visualization, parsing and text structure analysis -and some application-specific classes for the distributed full-text index -and servlets for the user interfaces and protocol implementation. +The YaCy search application is built on; +a set of packages for efficient I/O, visualization, parsing and text structure analysis, +some application-specific classes for the distributed full-text index, and +servlets for the user interfaces and protocol implementation. Packages: - net.yacy.kelondro ----------------- -depends on commons-logging -The core class for efficient IO: -- record-based stream writing -- blob-based stream writing -- large-scale full-ram indexes for up to 100 Million references - to object entries in record-streams and blob-streams -- logging, resource observation, work-flow control and utilities +Depends on commons-logging. +The core class for efficient I/O: +- Record-based stream writing. +- Blob-based stream writing. +- Large-scale full-RAM indexes for up to 100 million references + to object entries in record-streams and blob-streams. +- Logging, resource observation, work-flow control and utilities. net.yacy.visualization ---------------------- -has NO dependencies +Has NO dependencies The core class for image drawing that is used in visialization servlets. -This package contains system-independent drawing class that provide -a unique way to draw graphs and charts and write on these images with +This package contains system-independent drawing class that provides +a unique way to draw graphs and charts and write onto these images with a tiny 5x5 font. net.yacy.document ----------------- -has many dependencies, kelondro and text parser classes +Has many dependencies, kelondro and text parser classes The core package for document parsing and content analysis. Provides classes for text and image parsing, metadata generation -using dublin core metadata records. Text contents can be processed +using Dublin core metadata records. Text contents can be processed with language detection and annotated with analysis metadata -like geolocalization information (more to come). +like geolocalization info (more to come). net.yacy.repository ------------------- -depends on yacy.kelondro, yacy.document, commons-httpclient +Depends on yacy.kelondro, yacy.document, commons-httpclient The core package for document retrieval and data access connectors. Contains a web crawler, a OAI-PMH client and a document cache. -The document cache is integrated in a http client infrastructure +The document cache is integrated in a HTTP client infrastructure to provide a transparent access to documents that may either live -externally in the WWW or inside the repository cache. The cache stores -http header information and the full document data and is stored +externally in the WWW, or inside the repository cache. The cache stores +HTTP header info, and the full document data and is stored as a kelondro blob array. The integrated crawler provides support for -robots.txt crawler steering methods and is implemented in such a way +robots.txt crawler steering methods, and is implemented in such a way that target hosts are balanced when the crawler retrieves pages from the WWW. net.sbbi.upnp ------------- -has NO dependencies, a "homeless" package (see explanation below). -provides upnp functions for the YaCy p2p network bootstraping +Has NO dependencies, a "homeless" package (see explanation below). +Provides UPnP functions for bootstraping the YaCy p2p network. org.apache.tools.tar -------------------- -has NO dependencies, a "homeless" package (see explanation below). -provides un-tar functions for the net.yacy.document +Has NO dependencies, a "homeless" package (see explanation below). +Provides un-tar functions for the net.yacy.document. ^v^v^v^v^v^v^v^v^v^v^v^v^v^v^v^v^v^v^v^v^v^v^v^v^v^v^v^v^v^v^v^v^v^v^v^v "homeless" packages (see reference above) -YaCy contains 'homeless' packages that have not the necessary maintenance -sufficient enough for a linux release packagement. It was integrated +YaCy contains 'homeless' packages not meeting the necessary maintenance +required for Linux release packaging. It was integrated in the YaCy package structure because it is needed in the YaCy search -application, but cannot be found in a public available deban/fedora package. - +application, but cannot be found in a public available Deban/Fedora package.