From 083f891e404984dd2a4d7a971597a57a8407c59a Mon Sep 17 00:00:00 2001 From: farfromrefuge Date: Tue, 24 Oct 2023 12:23:46 +0200 Subject: [PATCH] readme/doc --- README.md | 259 ++++--- docs/assets/highlight.css | 31 +- docs/assets/main.js | 61 +- docs/assets/navigation.js | 1 + docs/assets/search.js | 2 +- docs/assets/style.css | 843 +++++++++++++---------- docs/functions/openFilePicker.html | 54 ++ docs/functions/pickFolder.html | 54 ++ docs/functions/saveFile.html | 54 ++ docs/index.html | 310 +++++---- docs/interfaces/FilePickerOptions.html | 113 +++ docs/interfaces/FolderPickerOptions.html | 99 +++ docs/modules.html | 53 +- 13 files changed, 1292 insertions(+), 642 deletions(-) create mode 100644 docs/assets/navigation.js create mode 100644 docs/functions/openFilePicker.html create mode 100644 docs/functions/pickFolder.html create mode 100644 docs/functions/saveFile.html create mode 100644 docs/interfaces/FilePickerOptions.html create mode 100644 docs/interfaces/FolderPickerOptions.html diff --git a/README.md b/README.md index 0ee39e3..494b1d2 100755 --- a/README.md +++ b/README.md @@ -1,81 +1,4 @@ - -[](#demos-and-development) - -## Demos and Development - - -### 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: -if you use `yarn` then run `yarn` -if you use `pnpm` then run `pnpm i` - -**Interactive Menu:** - -To start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`). This will list all of the commonly used scripts. - -### Build - -```bash -npm run build.all -``` - -### Demos - -```bash -npm run demo.[ng|react|svelte|vue].[ios|android] - -npm run demo.svelte.ios # Example -``` - - -[](#contributing) - -## Contributing - -### Update repo - -You can update the repo files quite easily - -First update the submodules - -```bash -npm run update -``` - -Then commit the changes -Then update common files - -```bash -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) -Simply run -```shell -npm run publish -``` -

+ -

- - -

Demos and Development

-
- - -

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: -if you use yarn then run yarn -if you use pnpm then run pnpm i

-

Interactive Menu:

-

To start the interactive menu, run npm start (or yarn start or pnpm start). This will list all of the commonly used scripts.

- - -

Build

-
-
npm run build.all
-
- - -

Demos

-
-
npm run demo.[ng|react|svelte|vue].[ios|android]

npm run demo.svelte.ios # Example -
-

- - -

Contributing

-
- - -

Update repo

-
-

You can update the repo files quite easily

-

First update the submodules

-
npm run update
-
-

Then commit the changes -Then update common files

-
npm run sync
-
-

Then you can run yarn|pnpm, commit changed files if any

- - -

Update readme

-
-
npm run readme
-
- - -

Update doc

-
-
npm run doc
-
- - -

Publish

-
-

The publishing is completely handled by lerna (you can add -- --bump major to force a major release) -Simply run

-
npm run publish
-
-



+