Skip to content

Commit 66d4d67

Browse files
author
Susan Douglas
committed
Updated installation.md to include note about installing from PEP packages
1 parent 9499e92 commit 66d4d67

1 file changed

Lines changed: 21 additions & 9 deletions

File tree

docs/installation.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,25 @@
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
@@ -24,7 +31,8 @@ Then, use `make` to ensure that your Go installation is configured properly:
2431
make deps
2532
```
2633

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

2937
```bash
3038
go mod download
@@ -36,20 +44,24 @@ Then, use `make` to build the Document Loader binary:
3644
make build
3745
```
3846

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:
47+
The `make build` command creates the `pgedge-docloader` binary in the `/bin`
48+
directory under your current directory. If you'd prefer to install the binary
49+
in `/usr/local/bin`, use the command:
4050

4151
```bash
4252
make install
4353
```
4454

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

4758
```bash
4859
PREFIX=/opt/local make install
4960
```
5061
**Verify the Installation**
5162

52-
After building Document Loader, you can verify the installation worked by retrieving information about the tool:
63+
After building Document Loader, you can verify the installation worked by
64+
retrieving information about the tool:
5365

5466
```bash
5567
pgedge-docloader version

0 commit comments

Comments
 (0)