Skip to content

Commit

Permalink
docu
Browse files Browse the repository at this point in the history
  • Loading branch information
flammie committed Jan 22, 2025
1 parent 1fc50be commit ef181da
Show file tree
Hide file tree
Showing 6 changed files with 198 additions and 254 deletions.
6 changes: 6 additions & 0 deletions NEWS
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
This file lists noteworthy changes between releases, for full list of changes,
see git log and then `ChangeLog.old`.

## Significant changes in 0.9.11

* New words from open sources: 7000 new lexemes
* minor fixes
* huge thanks to **Patreons** and **Github Sponsors** for their support

## Significant changes in 0.9.10

* new words from wiktionaries and open name databases: 77,000 new lexemes,
Expand Down
4 changes: 2 additions & 2 deletions configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Process this file with autoconf to produce a configure script.

AC_PREREQ([2.69])
AC_INIT([omorfi],[0.9.10],[https://github.com/flammie/omorfi/issues],[https://github.com/flammie/omorfi/])
AC_INIT([omorfi],[0.9.11],[https://github.com/flammie/omorfi/issues],[https://github.com/flammie/omorfi/])
LT_PREREQ([2.2.6])
AC_CONFIG_AUX_DIR([config-aux])
AM_INIT_AUTOMAKE([1.12 -Wall -Wno-portability -Werror foreign dist-xz color-tests subdir-objects])
Expand All @@ -11,7 +11,7 @@ AC_CONFIG_SRCDIR([src/cpp/omorfi.cc])
AC_CONFIG_HEADERS([config.h])

PACKAGE=omorfi
VERSION=0.9.10
VERSION=0.9.11

# Options
AC_ARG_WITH([hfst],
Expand Down
13 changes: 12 additions & 1 deletion docs/NEWS.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,20 @@
This file lists noteworthy changes between releases, for full list of changes,
see git log and then `ChangeLog.old`.

## Significant changes in 0.9.11

* New words from open sources: 7000 new lexemes
* minor fixes
* huge thanks to **Patreons** and **Github Sponsors** for their support

## Significant changes in 0.9.10

* new words from wiktionaries and open name databases: 77,000 new lexemes,
mostly proper nouns from the two government's open access name databases:
* all first names and surnames used in Finland from dvv.fi name registry
* all place names from the GML data by maanmittauslaitos
* get details from [statistics
page](https://flammie.github.io/omorfi/statistics.html)
* minor fixes to tags and formats, disambiguation and words:
* apertium format has more subcategories
* more words from wiktionaries have better paradigms (mainly consonant-final
Expand All @@ -18,7 +26,10 @@ see git log and then `ChangeLog.old`.
* test results show same compatibility as always, except:
* FTB-3.1 is down to 88 % from 90 % and
* UD vs. Finnish DTD is down to 92 % from 94 %
* big thanks to **Patreons** and **Github Sponsors** for continued support
* python stuff should only use hfst package and not (legacy?) libhfst
* newest hfst-python should again be installable from pip and other
packaging sources
* big thanks to **Patreons** and **Github Sponsors** for contiinued support

## Significant changes in 0.9.9

Expand Down
21 changes: 11 additions & 10 deletions docs/README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,11 @@ Omorfi source packages can be downloaded from github:
or the most current version using git. For more information, see
[Release policy](https://flammie.github.io/omorfi/releases.html)

For quick installation under restricted environments, see Python or Docker
instructions below.

## Dependencies

* **hfst-3.15** or greater,
* **python-3.5** or greater,
* **libhfst-python**,
* **hfst-python**,
* **C++** compiler and **libtool**
* GNU **autoconf-2.64**, **automake-1.12**; compatible **pkg-config**
implementation
Expand Down Expand Up @@ -93,20 +90,23 @@ syntactic analysis and disambiguation using VISL CG 3.
pip install omorfi
```

![Anaconda](https://anaconda.org/flammie/omorfi/badges/installer/conda.svg)
[![Anaconda](https://anaconda.org/flammie/omorfi/badges/installer/conda.svg)](https://anaconda.org/flammie/omorfi/)

```
conda install -c flammie omorfi
```

**NB: since conda does not have new version of hfst buildable with recent
pythons or something, only older versions are available on conda.**

### Docker

It is possible to use omorfi with a ready-made docker container, there is a
Dockerfile in `src/docker/Dockerfile` for that.

```
docker build -t omorfi Dockerfile
docker run -it omorfi bash
docker build -t "omorfi:Dockerfile" .
docker run -it "omorfi:Dockerfile" bash
```

## Usage
Expand Down Expand Up @@ -155,7 +155,7 @@ Update HFST.

In order for python scripts to work you need to install them to same prefix as
python, or define PYTHONPATH, e.g. `export
PYTHONPATH=/usr/local/lib/python3.4/site-packages/`
PYTHONPATH=/usr/local/lib/python3.11/site-packages/`

### Processing text gets stuck / takes long

Expand All @@ -177,8 +177,9 @@ participate, read further information in
* Issues and problems may be filed in [our github issue
tracker](https://github.com/flammie/omorfi/issues), including support
questions
* [IRC channel #omorfi on OFTC](irc://OFTC/#omorfi) is particularly good
for live chat for support questions, suggestions and discussions
* [Matrix channel omorfi](https://matrix.to/#/#omorfi:matrix.org) is
particularly good for live chat for support questions, suggestions and
discussions
* [omorfi-devel mailing
list](https://groups.google.com/forum/#!forum/omorfi-devel) is good for longer
more involved discussions
Expand Down
Loading

0 comments on commit ef181da

Please sign in to comment.