Skip to content

Commit a40af42

Browse files
committed
Add v3 cli changes to docs.
1 parent 34ba68c commit a40af42

File tree

4 files changed

+14
-11
lines changed

4 files changed

+14
-11
lines changed

Makefile

-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ VERSION := $(or $(shell git describe --tags --abbrev=0 2> /dev/null),$(shell gre
66

77
BUILDSTR := ${VERSION} (\#${LAST_COMMIT} $(shell date -u +"%Y-%m-%dT%H:%M:%S%z"))
88

9-
YARN ?= yarn
109
GOPATH ?= $(HOME)/go
1110
STUFFBIN ?= $(GOPATH)/bin/stuffbin
1211

docs/documentation/docs/import.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
dictpress comes with a built in CSV to database importer tool. Once dictionary data has been organised into
2-
the below described structure, import it by running `./dictpress --import=yourfile.csv`.
2+
the below described structure, import it by running `./dictpress import --file=yourfile.csv`.
33

44
Entries with the same content in the same language are not inserted into the database multiple times, but are instead re-used.
55
For instance, if there are multiple `Apple (English)` entries, it is inserted once but re-used in multiple relations.

docs/documentation/docs/installation.md

+12-8
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,23 @@
22

33
dictpress requires Postgres ⩾ v10.
44

5-
## Binary
5+
## Pre-built binary
66
- Download the [latest release](https://github.com/knadh/dictpress/releases) and extract the binary.
7-
- `./dictpress --new-config` to generate config.toml. Then, edit the file.
8-
- `./dictpress --install` to install the tables in the Postgres DB.
7+
- `./dictpress new-config` to generate config.toml. Then, edit the file.
8+
- `./dictpress install` to install the tables in the Postgres DB.
99
- Run `./dictpress` and visit `http://localhost:9000/admin`.
1010

1111
See [Importing data](import.md) to populate the dictionary database from CSVs.
1212

13-
1413
## Compiling from source
1514

16-
To compile the latest unreleased version (`master` branch):
15+
Make sure `go` is installed on your system.
16+
17+
1. Download or `git clone` the latest tagged release or the bleeding edge `master` branch from the [repository](https://github.com/knadh/listmonk).
18+
Eg: `git clone [email protected]:knadh/dictpress.git`
19+
20+
1. `cd` into the dictpress directory and run `make dist`. This compiles the `dictpress` binary.
21+
22+
## Upgrading
23+
Some releases may require schema changes to the existing database. If a release prompts for an upgrade, run `dictpress upgrade` to apply the necessary database migrations.
1724

18-
1. Make sure `go`, `nodejs`, and `yarn` are installed on your system.
19-
2. `git clone [email protected]:knadh/dictpress.git`
20-
3. `cd dictpress && make dist`. This will generate the `dictpress` binary.

docs/documentation/mkdocs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ theme:
77
language: "en"
88
font:
99
text: 'Inter'
10-
weights: 400
10+
weights: 400, 500, 600
1111
direction: 'ltr'
1212
extra:
1313
search:

0 commit comments

Comments
 (0)