summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGeo Halkiadakis <gchalkiadakis@sklavenitis.co.gr>2024-05-13 12:27:33 +0300
committerGeo Halkiadakis <gchalkiadakis@sklavenitis.co.gr>2024-05-13 12:27:33 +0300
commita677cc32eae5fdf40e9b424b3f42a5fbaf49fcb8 (patch)
tree08b7e8e6e15d8fe46f8fe52446b25207f373874c /README.md
parent05cd36c8fdfbafa9bfebe1c438138318830c819c (diff)
downloadlinkeysearch-a677cc32eae5fdf40e9b424b3f42a5fbaf49fcb8.tar.gz
linkeysearch-a677cc32eae5fdf40e9b424b3f42a5fbaf49fcb8.tar.bz2
linkeysearch-a677cc32eae5fdf40e9b424b3f42a5fbaf49fcb8.zip
modified gitignore #2
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..88ba073
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# 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`.
+
+## 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.)