Skip to content

Commit b949664

Browse files
authored
Merge pull request #7 from pgEdge/BR-378
Thanks for the documentation improvements!
2 parents 9499e92 + 0ef80c2 commit b949664

1 file changed

Lines changed: 24 additions & 10 deletions

File tree

docs/installation.md

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,39 @@
11
# Installation
22

3-
pgEdge Document Loader is open-source and licensed with the [PostgreSQL license](LICENCE.md). You can download pgEdge Document Loader source code from the [pgEdge repository](https://github.com/pgEdge/pgedge-docloader).
3+
pgEdge Document Loader loads documents into a Postgres database in Markdown
4+
format. You can install Document Loader with a
5+
[pgEdge Enterprise Postgres](https://docs.pgedge.com/enterprise/) package
6+
or build pgEdge Document Loader from source code stored in the
7+
[pgEdge repository](https://github.com/pgEdge/pgedge-docloader).
8+
9+
pgEdge Document Loader is open-source, and licensed with the
10+
[PostgreSQL license](LICENCE.md).
411

512
## Prerequisites
613

714
Before building Document Loader, install:
815

9-
- Go 1.21 or later
10-
- PostgreSQL 12 or later
11-
- Make (optional, for using Makefile targets)
16+
- Go 1.21 or later.
17+
- PostgreSQL version 12 or later.
18+
- Make (optional, for using Makefile targets to build from source).
1219

1320
## Building from Source
1421

15-
To build Document Loader from source, clone the pgedge-docloader repository:
22+
To build Document Loader from source, clone the `pgedge-docloader` repository:
1623

1724
```bash
1825
git clone https://github.com/pgedge/pgedge-docloader.git
1926
cd pgedge-docloader
2027
```
28+
2129
Then, use `make` to ensure that your Go installation is configured properly:
2230

2331
```bash
2432
make deps
2533
```
2634

27-
Alternatively, you can use the following command to ensure that Go is installed:
35+
Alternatively, you can use the following command to ensure that Go is
36+
installed:
2837

2938
```bash
3039
go mod download
@@ -36,20 +45,25 @@ Then, use `make` to build the Document Loader binary:
3645
make build
3746
```
3847

39-
The `make build` command creates the `pgedge-docloader` binary in the `/bin` directory in your current directory. If you'd prefer to install the binary in `/usr/local/bin`, use the command:
48+
The `make build` command creates the `pgedge-docloader` binary in the `/bin`
49+
directory under your current directory. If you'd prefer to install the binary
50+
in `/usr/local/bin`, use the command:
4051

4152
```bash
4253
make install
4354
```
4455

45-
To install the binary in a custom location, specify the installation path when you run the `make` command:
56+
To install the binary in a custom location, specify the installation path
57+
when you run the `make` command:
4658

4759
```bash
4860
PREFIX=/opt/local make install
4961
```
50-
**Verify the Installation**
5162

52-
After building Document Loader, you can verify the installation worked by retrieving information about the tool:
63+
## Verify the Installation
64+
65+
After building Document Loader, you can verify the installation worked by
66+
retrieving information about the tool:
5367

5468
```bash
5569
pgedge-docloader version

0 commit comments

Comments
 (0)