Update Readme and Changelog
Change-Id: I1373106f5d90bc884cd4087b6586dedcabc46f38
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 090f9c2..68edac4 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,7 +1,9 @@
# Changelog
-## [2.2.0] - 2022-12-07
+## [2.2.0] - 2022-12-21
- added option `--exclude-punctuation`
+- improve binary distribution build
+- add source distribution build
## [2.1.0] - 2022-12-01
- added script `GeneratePseudonymKey.groovy` to compute pseudonyms
diff --git a/Readme.md b/Readme.md
index dc74c12..14e4993 100644
--- a/Readme.md
+++ b/Readme.md
@@ -5,6 +5,17 @@
An older version of `totalngrams` was used for Koplenig et al. (2022).
+## Requirements
+
+- Java 17 or higher
+
+## Install from binary distribution
+
+```bash
+unzip totalngrams-2.2.0-bin.zip
+export PATH=`pwd`/totalngrams-2.2.0/bin:$PATH
+```
+
## Synopsis
```plain
@@ -108,21 +119,43 @@
filter_keys -k token_keys.tsv.xz -k lemma_keys.tsv.xz 1-gram-token-l-freqs.*.tsv.xz
```
-# Installation
+# Installation from source
### Prerequisites
* [Java Development Kit (JDK) >= 18](https://www.oracle.com/de/java/technologies/downloads/)
* [Apache Maven](https://maven.apache.org/)
-### Install
+### Build and install from git
+
```bash
git clone "https://korap.ids-mannheim.de/gerrit/IDS-Mannheim/totalngrams"
cd totalngrams
mvn install
-export PATH=`pwd`/appassembler/bin:$PATH
+export PATH=`pwd`/target/bin:$PATH
```
+# Changes
+
+See [Changelog](CHANGELOG.md).
+
+# Development and License
+
+**Authors**:
+* [Marc Kupietz](https://www.ids-mannheim.de/digspra/personal/kupietz.html)
+
+Copyright (c) 2022, [Leibniz Institute for the German Language](http://www.ids-mannheim.de/), Mannheim, Germany
+
+This package is published under the [Apache 2.0 License](LICENSE).
+
+## Contributions
+
+Contributions are very welcome!
+
+Your contributions should ideally be committed via our [Gerrit server](https://korap.ids-mannheim.de/gerrit/)
+to facilitate reviewing (see [Gerrit Code Review - A Quick Introduction](https://korap.ids-mannheim.de/gerrit/Documentation/intro-quick.html)
+if you are not familiar with Gerrit).
+
# References
* Koplenig, Alexander/Kupietz, Marc/Wolfer, Sascha (2022): [Testing the relationship between word length, frequency, and predictability based on the German Reference Corpus](http://dx.doi.org/10.1111/cogs.13090). Cognitive Science 46(6)