Skip to content

Commit 9e9d625

Browse files
committed
README update and restructuring, added documentation links and badge
1 parent 2a2ef7d commit 9e9d625

1 file changed

Lines changed: 35 additions & 32 deletions

File tree

README.md

Lines changed: 35 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
[![Build Status](https://travis-ci.org/LanguageMachines/frog.svg?branch=master)](https://travis-ci.org/LanguageMachines/frog) [![Language Machines Badge](http://applejack.science.ru.nl/lamabadge.php/frog)](http://applejack.science.ru.nl/languagemachines/) [![DOI](https://zenodo.org/badge/20526435.svg)](https://zenodo.org/badge/latestdoi/20526435)
1+
[![Build Status](https://travis-ci.org/LanguageMachines/frog.svg?branch=master)](https://travis-ci.org/LanguageMachines/frog) [![Documentation Status](https://readthedocs.org/projects/frognlp/badge/?version=latest)](https://frognlp.readthedocs.io/?badge=latest) [![Language Machines Badge](http://applejack.science.ru.nl/lamabadge.php/frog)](http://applejack.science.ru.nl/languagemachines/) [![DOI](https://zenodo.org/badge/20526435.svg)](https://zenodo.org/badge/latestdoi/20526435)
22

3-
Frog - A Tagger-Lemmatizer-Morphological-Analyzer-Dependency-Parser for Dutch
4-
==============================================================================
3+
# Frog - A Tagger-Lemmatizer-Morphological-Analyzer-Dependency-Parser for Dutch
54

6-
Copyright 2006-2017
5+
Copyright 2006-2019
76
Bertjan Busser, Antal van den Bosch, Ko van der Sloot, Maarten van Gompel
87

98
Centre for Language and Speech Technology, Radboud University Nijmegen
@@ -28,7 +27,7 @@ the Netherlands Organisation for Scientific Research, particularly under the
2827
CGN project, the IMIX programme, the Implicit Linguistics project, the
2928
CLARIN-NL programme and the CLARIAH programme.
3029

31-
-----------------------------------------------------------------------------
30+
## License
3231

3332
Frog is free software; you can redistribute it and/or modify it under the terms
3433
of the GNU General Public License as published by the Free Software Foundation;
@@ -44,38 +43,25 @@ lamasoftware (at) science.ru.nl.
4443
Updates and more info may be found on
4544
https://languagemachines.github.io/frog .
4645

47-
48-
----------------------------------------------------------------------------
49-
50-
This software has been tested on:
51-
- Intel platforms running several versions of Linux, including Ubuntu, Debian,
52-
Arch Linux, Fedora (both 32 and 64 bits)
53-
- Apple platform running Mac OS X 10.10
54-
55-
Contents of this distribution:
56-
- Sources
57-
- Licensing information ( COPYING )
58-
- Installation instructions ( INSTALL )
59-
- Build system based on GNU Autotools
60-
- Example data files ( in the demos directory )
61-
- Documentation ( in the docs directory )
46+
## Installation
6247

6348
To install Frog, first consult whether your distribution's package manager has
6449
an up-to-date package. If not, for easy installation of Frog and its many
6550
dependencies, it is included as part of our software distribution
6651
**LaMachine**: https://proycon.github.io/LaMachine .
6752

6853
To be able to succesfully build Frog from source instead, you need the following dependencies:
69-
- A sane C++ build enviroment with autoconf, automake, autoconf-archive, pkg-config, gcc or clang, libtool
70-
- libxml2-dev
71-
- libicu-dev
72-
- [ticcutils](https://github.com/LanguageMachines/ticcutils)
73-
- [libfolia](https://github.com/LanguageMachines/libfolia)
74-
- [uctodata](https://github.com/LanguageMachines/uctodata)
75-
- [ucto](https://github.com/LanguageMachines/ucto)
76-
- [timbl](https://github.com/LanguageMachines/timbl)
77-
- [mbt](https://github.com/LanguageMachines/mbt)
78-
- [frogdata](https://github.com/LanguageMachines/frogdata)
54+
55+
* A sane C++ build enviroment with autoconf, automake, autoconf-archive, pkg-config, gcc or clang, libtool
56+
* libxml2-dev
57+
* libicu-dev
58+
* [ticcutils](https://github.com/LanguageMachines/ticcutils)
59+
* [libfolia](https://github.com/LanguageMachines/libfolia)
60+
* [uctodata](https://github.com/LanguageMachines/uctodata)
61+
* [ucto](https://github.com/LanguageMachines/ucto)
62+
* [timbl](https://github.com/LanguageMachines/timbl)
63+
* [mbt](https://github.com/LanguageMachines/mbt)
64+
* [frogdata](https://github.com/LanguageMachines/frogdata)
7965

8066
The data for Frog is packaged seperately and needs to be installed prior to installing frog:
8167
- [frogdata](https://github.com/LanguageMachines/frogdata)
@@ -88,11 +74,28 @@ To compile and install manually from source instead, provided you have all the d
8874
$ make install
8975

9076
and optionally:
77+
9178
$ make check
9279

80+
This software has been tested on:
81+
82+
* Intel platforms running several versions of Linux, including Ubuntu, Debian, Arch Linux, Fedora (both 32 and 64 bits)
83+
* Apple platform running macOS
84+
85+
Contents of this distribution:
86+
87+
* Sources
88+
* Licensing information ( COPYING )
89+
* Installation instructions ( INSTALL )
90+
* Build system based on GNU Autotools
91+
* Example data files ( in the demos directory )
92+
* Documentation ( in the docs directory and on https://frognlp.readthedocs.io )
93+
94+
## Documentation
95+
96+
The Frog documentation can be found on https://frognlp.readthedocs.io
9397

94-
Credits
95-
-------------------------------------------------------------------------------
98+
## Credits
9699

97100
Many thanks go out to the people who made the developments of the Frog
98101
components possible: Walter Daelemans, Jakub Zavrel, Ko van der Sloot, Sabine

0 commit comments

Comments
 (0)