summaryrefslogtreecommitdiff
path: root/README.md
blob: 6e8fca230435bc725dc05790dabc4afae7c647d2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# linkeysearch

Project name is the join of the words `linK-KeyS-Search`;

The purpose of the project is to create an optimized data-structure that describes the connection of the words that make up the title of entities, in order to be used in a next-word suggestion engine of some search engine.



# Coded in

* python (for prototyping), and
* javascript (for performance)



# Licence

`linkeysearch` is under **GPL2 with linking exception**.
This means you can link to and use the library from any program,
proprietary or open source; paid or gratis.
However, if you modify `linkeysearch` itself, you must distribute the source
to your modified version of `linkeysearch`.

## Licence Note

The only valid version of the GPL as far as this project is concerned
is v2 of the license (not v2.2 or v3.x or whatever),
unless explicitly otherwise stated.

## Linking Exception

In addition to the permissions in the GNU General Public License,
the authors give you unlimited permission to link the compiled
version of this library into combinations with other programs,
and to distribute those combinations without any restriction
coming from the use of this file.  (The General Public License
restrictions do apply in other respects; for example, they cover
modification of the file, and distribution when not linked into
a combined executable.)



# Spare Notes

The project includes a banch of non-related to the project code
(like promise tests, async practies etc.); sorry!
they are about to be removed