Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pemistahl committed Oct 20, 2021
1 parent 6ecb581 commit c67de11
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 9 deletions.
9 changes: 1 addition & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,7 @@ sentence on a separate line. Do **not** rename the test data files.
language's ISO 639-1 code and put the language model files into it.
Look at the other languages' directories to see how it looks like. It should be pretty self-explanatory.
8. Put the test data files in [`/language-testdata`][testdata directory url].
9. Add the new language to the functions in [`unigrams.go`][unigrams url], [`bigrams.go`][bigrams url],
[`trigrams.go`][trigrams url], [`quadrigrams.go`][quadrigrams url] and [`fivegrams.go`][fivegrams url].
Add it to [`/cmd/accuracy_reporter.go`][accuracy reporter url] as well.
9. Add the new language to [`/cmd/accuracy_reporter.go`][accuracy reporter url] as well.
10. Fix the existing unit tests by adding your new language.
11. For accuracy report generation, run `go run cmd/accuracy_reporter.go`.
12. Be happy! :-) You have successfully contributed a new language and have thereby significantly widened
Expand All @@ -55,9 +53,4 @@ this library's fields of application.
[test data files writer url]: https://github.com/pemistahl/lingua-go/blob/main/writer.go#L194
[language models directory url]: https://github.com/pemistahl/lingua-go/tree/main/language-models
[testdata directory url]: https://github.com/pemistahl/lingua-go/tree/main/language-testdata
[unigrams url]: https://github.com/pemistahl/lingua-go/blob/main/unigrams.go
[bigrams url]: https://github.com/pemistahl/lingua-go/blob/main/bigrams.go
[trigrams url]: https://github.com/pemistahl/lingua-go/blob/main/trigrams.go
[quadrigrams url]: https://github.com/pemistahl/lingua-go/blob/main/quadrigrams.go
[fivegrams url]: https://github.com/pemistahl/lingua-go/blob/main/fivegrams.go
[accuracy reporter url]: https://github.com/pemistahl/lingua-go/blob/main/cmd/accuracy_reporter.go
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ Erroneously classified as Dutch: 0.20%, Latin: 0.10%

## 7. <a name="library-dependency"></a> How to add it to your project? <sup>[Top ▲](#table-of-contents)</sup>

go get github.com/pemistahl/[email protected].2
go get github.com/pemistahl/[email protected].3

## 8. <a name="library-build"></a> How to build? <sup>[Top ▲](#table-of-contents)</sup>

Expand Down
9 changes: 9 additions & 0 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
## Lingua 1.0.3 (released on 20 Oct 2021)

### Improvements

- By replacing [sync.Once](https://pkg.go.dev/sync#Once) with
[sync.Map](https://pkg.go.dev/sync#Map) for storing the language models
at runtime, a large amount of code could be removed while preserving
the same functionality. This improves code maintenance significantly.

## Lingua 1.0.2 (released on 13 Oct 2021)

### Bug Fixes
Expand Down

0 comments on commit c67de11

Please sign in to comment.