chore: reamde

Author: farfromrefug

packages/gesturehandler/README.md

@@ -50,7 +50,10 @@
 	* [Demos](#demos)
 * [Contributing](#contributing)
 	* [Update repo ](#update-repo-)
+	* [Update readme ](#update-readme-)
+	* [Update doc ](#update-doc-)
 	* [Publish](#publish)
+	* [modifying submodules](#modifying-submodules)
 * [Questions](#questions)
 
 
@@ -141,6 +144,11 @@ The source is based on the source code by [Krzysztof Magiera](https://github.com
 
 ### Repo Setup
 
+The repo uses submodules. If you did not clone with ` --recursive` then you need to call
+```
+git submodule update --init
+```
+
 The package manager used to install and link dependencies must be `pnpm` or `yarn`. `npm` wont work.
 
 To develop and test:
@@ -156,6 +164,7 @@ To start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`)
 ```bash
 npm run build.all
 ```
+WARNING: it seems `yarn build.all` wont always work (not finding binaries in `node_modules/.bin`) which is why the doc explicitly uses `npm run`
 
 ### Demos
 
@@ -165,6 +174,10 @@ npm run demo.[ng|react|svelte|vue].[ios|android]
 npm run demo.svelte.ios # Example
 ```
 
+Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in `demo-[ng|react|svelte|vue]`
+Instead you work in `demo-snippets/[ng|react|svelte|vue]`
+You can start from the `install.ts` of each flavor to see how to register new demos 
+
 
 [](#contributing)
 
@@ -188,6 +201,16 @@ npm run sync
 ```
 Then you can run `yarn|pnpm`, commit changed files if any
 
+### Update readme 
+```bash
+npm run readme
+```
+
+### Update doc 
+```bash
+npm run doc
+```
+
 ### Publish
 
 The publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release)
@@ -196,6 +219,15 @@ Simply run
 npm run publish
 ```
 
+### modifying submodules
+
+The repo uses https:// for submodules which means you won't be able to push directly into the submodules.
+One easy solution is t modify `~/.gitconfig` and add
+```
+[url "ssh://[email protected]/"]
+	pushInsteadOf = https://github.com/
+```
+
 
 [](#questions)