-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
35 additions
and
64 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,60 +1,29 @@ | ||
|
|
||
| For general information about developing packages, see the Dart guide for | ||
| [creating packages](https://dart.dev/guides/libraries/create-packages) | ||
| and the Flutter guide for | ||
| [developing packages and plugins](https://flutter.dev/to/develop-packages). | ||
| --> | ||
|
|
||
| # Tauweb | ||
|
|
||
| `Tauweb` is an [Etau](https://pub.dev/packages/etau) implementation for Flutter Web. | ||
|
|
||
| [Etau](https://pub.dev/packages/etau) is the interface and this is what see the App. | ||
| So, there are not many things to say about `Tauweb` because this is just an implementation. | ||
| The only verb used by the App is `tau()`, which gives the implementation. | ||
|
|
||
| You can see all the [Etau project documentation](https://tau.canardoux.xyz/etau-README.html) here. | ||
|
|
||
| Example | ||
| ```dart | ||
| import 'package:etau/etau.dart'; | ||
| import 'package:tau_web/tau_web.dart'; | ||
| @override | ||
| void initState() | ||
| { | ||
| super.initState(); | ||
| tau().init().then | ||
| ((e){ | ||
| audioCtx = tau().newAudioContext(); | ||
| }); | ||
| } | ||
| ... | ||
| // Then all the code depends only on the interface (`etau`) | ||
| dest = audioCtx.destination; | ||
| source = audioCtx.createBufferSource(); | ||
| source!.buffer = audioBuffer; | ||
| pannerNode = audioCtx.createStereoPanner(); | ||
| pannerNode!.pan.value = pannerValue; | ||
| source!.connect(pannerNode!).connect(dest!); | ||
| ``` | ||
|
|
||
| if your App needs to support at the same time Fliutter Web And Flutter on mobiles: | ||
| ```dart | ||
| import 'package:etau/etau.dart'; | ||
| import 'package:etau/dummy.dart' | ||
| if (dart.library.js_interop) 'package:tau_web/tau_web.dart' | ||
| if (dart.library.io) 'package:tau_war/tau_war.dart'; | ||
| @override | ||
| void initState() | ||
| { | ||
| super.initState(); | ||
| tau().init().then | ||
| ((e){ | ||
| audioCtx = tau().newAudioContext(); | ||
| }); | ||
| } | ||
| ``` | ||
| If [Jekyll] is installed on your computer, you can also build and preview the created site *locally*. This lets you test changes before committing them, and avoids waiting for GitHub Pages.[^1] And you will be able to deploy your local build to a different platform than GitHub Pages. | ||
|
|
||
| More specifically, the created site: | ||
|
|
||
| - uses a gem-based approach, i.e. uses a `Gemfile` and loads the `just-the-docs` gem | ||
| - uses the [GitHub Pages / Actions workflow] to build and publish the site on GitHub Pages | ||
|
|
||
| Other than that, you're free to customize sites that you create with this template, however you like. You can easily change the versions of `just-the-docs` and Jekyll it uses, as well as adding further plugins. | ||
|
|
||
| [Browse our documentation][Just the Docs] to learn more about how to use this theme. | ||
|
|
||
| To get started with creating a site, simply: | ||
|
|
||
| 1. click "[use this template]" to create a GitHub repository | ||
| 2. go to Settings > Pages > Build and deployment > Source, and select GitHub Actions | ||
|
|
||
| If you want to maintain your docs in the `docs` directory of an existing project repo, see [Hosting your docs from an existing project repo](https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md#hosting-your-docs-from-an-existing-project-repo) in the template README. | ||
|
|
||
| ---- | ||
|
|
||
| [^1]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site). | ||
|
|
||
| [Just the Docs]: https://just-the-docs.github.io/just-the-docs/ | ||
| [GitHub Pages]: https://docs.github.com/en/pages | ||
| [README]: https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md | ||
| [Jekyll]: https://jekyllrb.com | ||
| [GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/ | ||
| [use this template]: https://github.com/just-the-docs/just-the-docs-template/generate |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters