From e62af618eb9ac57d1a3a386614ad165c5b7eee02 Mon Sep 17 00:00:00 2001 From: Taylor Bantle Date: Wed, 24 Apr 2024 10:57:02 -0700 Subject: [PATCH] Fix typo and go test command --- CONTRIBUTING.md | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 61c625cfba..a949aa43d2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,7 +16,7 @@ In addition, it is worthwhile to have a local PostgreSQL instance installed to c 5. **Build the parser**: Run the `doltgresql/postgres/parser/build.sh` script. This creates a few files within the `doltgresql/postgres/parser/parser` directory that are necessary for parsing PostgreSQL statements. It is recommended to run this file every time you pull changes into your local repository, as these generated files are not included since they would cause near guaranteed merge conflicts. -6. **Run Go tests**: Before building the project, you should always run all of the tests, which can be done by running `go run test ./... --count=1` from the source root directory. +6. **Run Go tests**: Before building the project, you should always run all of the tests, which can be done by running `go test ./... --count=1` from the source root directory. This ensures that all Go tests pass, which also ensures that your Go environment is installed and configured correctly. 7. **Build the binary**: From the source root directory, run `go build -o .`, where `` is the name of the binary (usually `doltgres` or `doltgres.exe`). To run the program without creating an executable, run `go run .`. diff --git a/README.md b/README.md index 522b7c6d72..350eadcd63 100644 --- a/README.md +++ b/README.md @@ -234,5 +234,5 @@ did not run could not complete due to a timeout earlier in the run. Doltgres emulates a Postgres server, including parsing Postgres SQL into an Abstract Syntax Tree (AST). This AST is converted to a form that can be interpreted by the Dolt engine. Doltgres uses the same SQL engine and storage format as Dolt. -[Dolt has a unique architecure](https://docs.dolthub.com/architecture/architecture) that allows for version control +[Dolt has a unique architecture](https://docs.dolthub.com/architecture/architecture) that allows for version control features at OLTP database performance. Doltgres uses the same architecture.