Skip to content

Commit fe304fc

Browse files
committed
docs: add documentation site to README.md
1 parent cda15f8 commit fe304fc

File tree

1 file changed

+27
-16
lines changed

1 file changed

+27
-16
lines changed

README.md

Lines changed: 27 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -40,22 +40,6 @@ Extension creates separate view in debug section - `PG Variables`. It contains p
4040
- `NameData` - string value directly
4141
- Enum values, which defined using preprocessor (`#define`) are shown as enum values, not integers.
4242

43-
### Configuration file
44-
45-
Extension has configuration file - `.vscode/pgsql_hacker_helper.json`.
46-
Main purpose is to allow to define container elements custom types, i.e. when you are developing a contrib.
47-
48-
It allows adding information about:
49-
50-
- Custom array types (with dynamic length evaluation using provided expressions)
51-
- Pointer types in `List *`, which are not Node-derived
52-
- HashTable entry types for both `HTAB` and `simplehash`
53-
- Custom `typedefs.list` files for formatter
54-
55-
Also there is VS Code settings with generic behavior customization.
56-
57-
For more info check [configuration file documentation](./docs/configuration.md).
58-
5943
### Formatting
6044

6145
Extension uses `pgindent` for formatting C code. It integrates with VS Code extension and available with `Format Document` or `Ctrl + Shift + I` shortcut (or another key binding if overridden). Or you can just specify formatter manually using `Format Document With...` - select `PostgreSQL Hacker Helper` in pick up box.
@@ -100,6 +84,33 @@ Also, for there is autocompletion for configuration parameters also with default
10084

10185
This syntax must be enabled for `postgresql[.auto].conf` files, but you can specify it using 'Change Language Mode' -> 'PostgreSQL configuration'
10286

87+
## Configuration
88+
89+
Extension has configuration file - `.vscode/pgsql_hacker_helper.json`.
90+
Main purpose is to allow to define container elements custom types, i.e. when you are developing a contrib.
91+
92+
It allows adding information about:
93+
94+
- Custom array types (with dynamic length evaluation using provided expressions)
95+
- Pointer types in `List *`, which are not Node-derived
96+
- HashTable entry types for both `HTAB` and `simplehash`
97+
- Custom `typedefs.list` files for formatter
98+
99+
Also there is VS Code settings with generic behavior customization.
100+
101+
For more info check [configuration file documentation](./docs/configuration.md).
102+
103+
## Documentation
104+
105+
Documentation is available locally in [`docs` directory](./docs/).
106+
107+
Also, there is [Read the docs](https://ashenBlade.github.io/postgres-dev-helper) site with:
108+
109+
- PostgreSQL and VS Code setup
110+
- Useful development scripts
111+
- Configuration file usage example
112+
- Usage examples, i.e. contrib development example
113+
103114
## Compatibility
104115

105116
Compatibility is ensured using testing. Minimal supported versions are **PostgreSQL 9.6** and **VS Code 1.70**.

0 commit comments

Comments
 (0)