Skip to content

Commit

Permalink
Merge pull request #191 from dolthub/taylor/docs
Browse files Browse the repository at this point in the history
Fix typo and go test command in docs
  • Loading branch information
tbantle22 authored Apr 24, 2024
2 parents 59c0a50 + e62af61 commit 0d4c378
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <bin_name> .`, where `<bin_name>` is the name of the binary (usually `doltgres` or `doltgres.exe`).
To run the program without creating an executable, run `go run .`.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 0d4c378

Please sign in to comment.