1diff --git a/Makefile b/Makefile
2index 8190661729693584d1254d5ffb5cef420e25bc75..de3668f59e569efacb48a6a89cb0b04318b0309a 100644
3--- a/Makefile
4+++ b/Makefile
5@@ -1,9 +1,23 @@
6-BIN?=bin/dict
7+VERSION?=$(shell cat VERSION)
8+BIN?=dict
9+PREFIX?=/usr/local
10+BINDIR?=$(PREFIX)/bin
11+SHAREDIR ?= $(PREFIX)/share/$(BIN)
12+OUT=./bin/$(BIN)
13+EXT=./ext/libsqlite3ext.so
14+
15+GO_LDFLAGS:= -s -w
16+GO_LDFLAGS+= -X main.Version=$(VERSION)
17+GO_LDFLAGS+= -X git.gabrielgio.me/dict/db.LibPath=$(SHAREDIR)/libsqlite3ext
18 GO_BUILD=go build -v --tags "fts5"
19 GO_RUN=go run -v --tags "fts5"
20
21-buid: ext
22- $(GO_BUILD) -o $(BIN) ./cmd/dict/main.go
23+build: ext
24+ $(GO_BUILD) -ldflags "$(GO_LDFLAGS)" -o $(OUT) ./cmd/dict/main.go
25+
26+install:
27+ install -Dm755 $(OUT) $(BINDIR)/$(BIN)
28+ install -Dm644 $(EXT) $(SHAREDIR)/libsqlite3ext.so
29
30 run: ext
31 $(GO_RUN) ./cmd/dict/main.go ui
32@@ -14,7 +28,14 @@
33 serve: ext
34 $(GO_RUN) ./cmd/dict/main.go serve
35
36+version: ext
37+ $(GO_RUN) ./cmd/dict/main.go version
38+
39+uninstall:
40+ rm $(BINDIR)/$(BIN)
41+ rm $(SHAREDIR)/libsqlite3ext.so
42+
43+
44+.PHONY: ext
45 ext:
46 gcc -shared -o ext/libsqlite3ext.so -fPIC ext/spellfix.c
47-
48-.PHONY: ext
49diff --git a/README.md b/README.md
50new file mode 100644
51index 0000000000000000000000000000000000000000..f5faf7de747c2f10aaf438fb163a75fac483c69c
52--- /dev/null
53+++ b/README.md
54@@ -0,0 +1,78 @@
55+# Iterative dictionary
56+
57+The goal is to provide a frictionless dictionary searching experience: you type
58+and the words show up on your prompt. Not need to wait a http request to go
59+through.
60+
61+As of right now, dict just provides a thin layer on top of sqlite's fts5[^1]
62+virtual table with support of spellfix[^2] for word suggestion.
63+
64+The whole database is loaded in memory for faster search and import process,
65+which means that this application will consume substantial amounts of memory.
66+On DE-EN dictionary, for example, it uses ~300MB, more then dict.cc tab on
67+firefox (but less the most electron application out there)
68+
69+# Compiling
70+
71+You will need go, gcc and sqlite-dev, then you can just run
72+
73+```sh
74+make
75+```
76+
77+For development you can run:
78+
79+```sh
80+make run # run the ui with default values
81+make import # run the importer with default values
82+make version # run the version command
83+```
84+
85+# Installing
86+
87+To install locally you may run:
88+
89+```sh
90+PREFIX=$(HOME)/.local make install
91+```
92+
93+Or for a system wide istall:
94+
95+```sh
96+sudo make install
97+```
98+
99+# Usage
100+
101+To run the importer you will need to download dict.cc dictionary.
102+First go to its request page[^3] and select your dictionary of choice.
103+Once you download and unzip run the following command:
104+
105+```sh
106+dict import --input dict.txt --output main.dict
107+```
108+
109+Once the import process is complete[4] you can run the ui.
110+
111+```sh
112+dict ui --database main.dict
113+```
114+
115+# TODO
116+
117+- On disk operation: to reduce memory footprint we can read from the disk. We
118+ would need to remove the instance response, since that is not possible
119+ reading from the disk.
120+- Better coloring on the list.
121+- Better default path for sqlite database making use of XDG variables.
122+- [optional] Multi dictionary support. Support more than one dict at once.
123+- Async response. Even though in memory is fast enough most often it can have
124+ some hiccups with 2 letter queries.
125+- Finish server
126+- Alpine package
127+
128+
129+[^1]: https://sqlite.org/fts5.html
130+[^2]: https://www.sqlite.org/spellfix1.html
131+[^3]: https://www1.dict.cc/translation_file_request.php
132+[4]: It may take some time depending the size of the dictionary you selected
133diff --git a/VERSION b/VERSION
134new file mode 100644
135index 0000000000000000000000000000000000000000..b82608c0bb54a84ae7b3d38112ccf1cb50aebe8d
136--- /dev/null
137+++ b/VERSION
138@@ -0,0 +1 @@
139+v0.1.0
140diff --git a/cmd/dict/main.go b/cmd/dict/main.go
141index 5bd60961e253fce4164294ee8db575dbec452b89..9dc98cf58caa9536b14854fde509d3d164e82e11 100644
142--- a/cmd/dict/main.go
143+++ b/cmd/dict/main.go
144@@ -1,16 +1,21 @@
145 package main
146
147 import (
148+ "fmt"
149 "log/slog"
150 "os"
151+ "path/filepath"
152
153 "github.com/urfave/cli/v2"
154
155 "git.gabrielgio.me/dict/cmd/importer"
156 "git.gabrielgio.me/dict/cmd/server"
157 "git.gabrielgio.me/dict/cmd/ui"
158+ "git.gabrielgio.me/dict/db"
159 )
160
161+var Version = "local"
162+
163 func main() {
164 app := &cli.App{
165 Name: "dict",
166@@ -19,6 +24,16 @@ Commands: []*cli.Command{
167 importer.ImportCommand,
168 ui.UICommand,
169 server.ServeCommand,
170+ {
171+ Name: "version",
172+ Usage: "print current version",
173+ Flags: []cli.Flag{},
174+ Action: func(cCtx *cli.Context) error {
175+ fmt.Printf("%s - %s\n\n", filepath.Base(os.Args[0]), Version)
176+ fmt.Printf("Spellfix locaton: %s.so", db.LibPath)
177+ return nil
178+ },
179+ },
180 },
181 }
182
183diff --git a/db/db.go b/db/db.go
184index 61f3bb5c2d8240e651ca80c8ff127201c7b965bc..c3699d79fe965aea28372e1b68f1950d4775fb86 100644
185--- a/db/db.go
186+++ b/db/db.go
187@@ -9,6 +9,8 @@
188 "github.com/mattn/go-sqlite3"
189 )
190
191+var LibPath = "ext/libsqlite3ext"
192+
193 type (
194 DB struct {
195 db *sql.DB
196@@ -24,7 +26,7 @@
197 func Open(filename string) (*DB, error) {
198 sql.Register("sqlite3_with_extensions", &sqlite3.SQLiteDriver{
199 ConnectHook: func(conn *sqlite3.SQLiteConn) error {
200- return conn.LoadExtension("ext/libsqlite3ext", "sqlite3_spellfix_init")
201+ return conn.LoadExtension(LibPath, "sqlite3_spellfix_init")
202 },
203 })
204