Skip to content

Commit 16be6aa

Browse files
committed
Merge pull request #169 from tetengo/readme
Readme (cherry picked from commit a89bf1f)
1 parent 8f142a4 commit 16be6aa

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ It is a pull-style parser based on
1919
[RFC 8259](https://tools.ietf.org/html/rfc8259), plus an extension for
2020
supporting UNIX shell style comments.
2121

22+
- [Detail
23+
description](https://www.tetengo.org/doc/namespacetetengo_1_1json.html)
24+
2225
### tetengo::lattice
2326

2427
A Viterbi search library.
@@ -29,6 +32,9 @@ path in the lattice consisting of the observed event nodes.
2932
This library also provides the A* search algorithm for the lattice created by
3033
the Viterbi search.
3134

35+
- [Detail
36+
description](https://www.tetengo.org/doc/namespacetetengo_1_1lattice.html)
37+
3238
### tetengo::property
3339

3440
An application setting library.
@@ -39,6 +45,9 @@ way.
3945
The storage of the settings is platform-specific: the Windows registry on
4046
Windows, home directory dot files on UNIX, etc.
4147

48+
- [Detail
49+
description](https://www.tetengo.org/doc/namespacetetengo_1_1property.html)
50+
4251
### tetengo::text
4352

4453
A text library.
@@ -50,6 +59,8 @@ This library provides the following features:
5059
- A string encoding converter.
5160
- A grapheme splitter conforming to
5261
[Unicode 13.0.0](https://unicode.org/versions/Unicode13.0.0/).
62+
- [Detail
63+
description](https://www.tetengo.org/doc/namespacetetengo_1_1text.html)
5364

5465
### tetengo::trie
5566

@@ -61,6 +72,8 @@ Given a key, it returns the corresponding value in a constant time.
6172
The trie is also able to perform a prefix search.
6273
It has a method to enumerate the values with the same prefix.
6374

75+
- [Detail description](https://www.tetengo.org/doc/namespacetetengo_1_1trie.html)
76+
6477
How to Build and Install
6578
------------------------
6679

@@ -85,16 +98,14 @@ necessary in addition to the above tools.
8598

8699
- [Git](https://git-scm.com/)
87100

88-
#### Getting built library files
89-
90-
##### Downloading the prebuilt library files
101+
#### Downloading the prebuilt library files
91102

92103
Download the .zip archive file for Windows from the website
93104
[www.tetengo.org](https://www.tetengo.org/).
94105

95106
Execute `setup.exe` in the archive..
96107

97-
##### Building from the source files cloned from the GitHub repository
108+
#### Building from the source files cloned from the GitHub repository
98109

99110
Clone the source files from GitHub:
100111

@@ -111,7 +122,7 @@ Execute the menu command [Build]-[Build Solution] in Visual Studio.
111122
Open the file `tetengo.setup.sln` in the work tree, and execute the menu
112123
command [Build]-[Build Solution] in Visual Studio.
113124

114-
`setup.exe` and `tetengi.msi` will be created under the `bin.setup` folder in
125+
`setup.exe` and `tetengo.msi` will be created under the `bin.setup` folder in
115126
the work tree.
116127

117128
#### Generating documents

0 commit comments

Comments
 (0)