Add getting started section to readme

Author: Hendrik van Antwerpen

languages/tree-sitter-stack-graphs-typescript/README.md

@@ -42,6 +42,8 @@ The project is organized as follows:
 - Builtins sources and configuration are defined in `src/builtins.ts` and `builtins.cfg` respectively.
 - Tests are put into the `test` directory.
 
+### Building and Running Tests
+
 Build the project by running:
 
 ``` sh
@@ -70,10 +72,15 @@ Sources are formatted using the standard Rust formatted, which is applied by run
 $ cargo fmt
 ```
 
-The stack graph rules are written in [tree-sitter-graph][], which provides a VSCode
-extension for syntax highlighting.
+### Writing TSG
+
+The stack graph rules are written in [tree-sitter-graph][]. Checkout the [examples][],
+which contain self-contained TSG rules for specific language features. A VSCode
+[extension][] is available that provides syntax highlighting for TSG files.
 
 [tree-sitter-graph]: https://github.com/tree-sitter/tree-sitter-graph
+[examples]: https://github.com/github/stack-graphs/blob/main/tree-sitter-stack-graphs/examples/
+[extension]: https://marketplace.visualstudio.com/items?itemName=tree-sitter.tree-sitter-graph
 
 Parse and test a single file by executing the following commands:
 
@@ -82,8 +89,7 @@ $ cargo run --features cli -- parse FILES...
 $ cargo run --features cli -- test TESTFILES...
 ```
 
-Additional flags can be passed to these commands as well. For example, to generate
-a visualization for the test, execute:
+Generate a visualization to debug failing tests by passing the `-V` flag:
 
 ``` sh
 $ cargo run --features cli -- test -V TESTFILES...

tree-sitter-stack-graphs/README.md

@@ -39,7 +39,22 @@ Alternatively, the program can be invoked via NPM as follows:
 $ npx tree-sitter-stack-graphs
 ```
 
-Check out our [examples](https://github.com/github/stack-graphs/blob/main/tree-sitter-stack-graphs/examples/) for more details on how to work with the CLI.
+## Getting Started
+
+Starting a new project to develop stack graph definitions for your favourite language
+is as easy as running the `init` command:
+
+``` sh
+$ tree-sitter-stack-graphs init PROJECT_DIR
+```
+
+Answer the questions to provide information about the language, the grammar dependency, and
+the project and hit `Generate` to generate the new project. Check out `PROJECT_DIR/README.md`
+to find out how to start developing.
+
+Also check out our [examples][] for more details on how to work with the CLI.
+
+[examples]: https://github.com/github/stack-graphs/blob/main/tree-sitter-stack-graphs/examples/
 
 ## Development
 

tree-sitter-stack-graphs/src/cli/init.rs

@@ -308,13 +308,14 @@ impl ProjectSettings {
 
             [rustup]: https://rustup.rs/
 
-
             The project is organized as follows:
 
             - The stack graph rules are defined in `src/stack-graphs.tsg`.
             - Builtins sources and configuration are defined in `src/builtins.{}` and `builtins.cfg` respectively.
             - Tests are put into the `test` directory.
 
+            ### Building and Running Tests
+
             Build the project by running:
 
             ``` sh
@@ -341,9 +342,15 @@ impl ProjectSettings {
             $ cargo fmt
             ```
 
-            The stack graph rules are written in [tree-sitter-graph][], which provides a VSCode extension for syntax highlighting.
+            ### Writing TSG
+
+            The stack graph rules are written in [tree-sitter-graph][]. Checkout the [examples][],
+            which contain self-contained TSG rules for specific language features. A VSCode
+            [extension][] is available that provides syntax highlighting for TSG files.
 
             [tree-sitter-graph]: https://github.com/tree-sitter/tree-sitter-graph
+            [examples]: https://github.com/github/stack-graphs/blob/main/tree-sitter-stack-graphs/examples/
+            [extension]: https://marketplace.visualstudio.com/items?itemName=tree-sitter.tree-sitter-graph
 
             Parse and test a single file by executing the following commands:
 
@@ -352,7 +359,7 @@ impl ProjectSettings {
             $ cargo run --features cli -- test TESTFILES...
             ```
 
-            Additional flags can be passed to these commands as well. For example, to generate a visualization for the test, execute:
+            Generate a visualization to debug failing tests by passing the `-V` flag:
 
             ``` sh
             $ cargo run --features cli -- test -V TESTFILES...