From 0bf42dff2584416d8bc64a8113c35b726310304d Mon Sep 17 00:00:00 2001 From: Mark Parker Date: Mon, 18 Sep 2023 08:06:23 +0200 Subject: [PATCH] license, docs.home --- LICENSE.md | 74 +++++++++++-------- .../commands-context.md} | 0 docs/advanced/custom-interfaces.md | 0 docs/advanced/custom-run.md | 0 docs/advanced/external-triggers.md | 0 docs/advanced/fallback-command.md | 0 .../localization-and-multi-language.md | 0 docs/advanced/optimization.md | 0 docs/advanced/other.md | 0 docs/advanced/voice-assistant.md | 0 docs/command-response.md | 0 docs/commands-context.md | 0 ...ntributing-and-shared-usage-stark-place.md | 10 +++ docs/creating-commands.md | 0 docs/dependency-injection.md | 0 docs/first-steps.md | 1 + docs/home.md | 37 ++++++++++ docs/installation.md | 2 + docs/patterns.md | 0 docs/sync-vs-async-commands.md | 0 docs/voice-assistant.md | 0 docs/where-to-host.md | 0 mkdocs.yml | 28 ++++++- pyproject.toml | 4 +- 24 files changed, 124 insertions(+), 32 deletions(-) rename docs/{index.md => advanced/commands-context.md} (100%) create mode 100644 docs/advanced/custom-interfaces.md create mode 100644 docs/advanced/custom-run.md create mode 100644 docs/advanced/external-triggers.md create mode 100644 docs/advanced/fallback-command.md create mode 100644 docs/advanced/localization-and-multi-language.md create mode 100644 docs/advanced/optimization.md create mode 100644 docs/advanced/other.md create mode 100644 docs/advanced/voice-assistant.md create mode 100644 docs/command-response.md create mode 100644 docs/commands-context.md create mode 100644 docs/contributing-and-shared-usage-stark-place.md create mode 100644 docs/creating-commands.md create mode 100644 docs/dependency-injection.md create mode 100644 docs/first-steps.md create mode 100644 docs/home.md create mode 100644 docs/installation.md create mode 100644 docs/patterns.md create mode 100644 docs/sync-vs-async-commands.md create mode 100644 docs/voice-assistant.md create mode 100644 docs/where-to-host.md diff --git a/LICENSE.md b/LICENSE.md index dc1adf9..6c095f1 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,42 +1,48 @@ -# Attribution-NonCommercial-NoDerivatives 4.0 International +# Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International -> *Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible.* -> -> ### Using Creative Commons Public Licenses -> -> Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses. -> -> * __Considerations for licensors:__ Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. [More considerations for licensors](http://wiki.creativecommons.org/Considerations_for_licensors_and_licensees#Considerations_for_licensors). -> -> * __Considerations for the public:__ By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described. Although not required by our licenses, you are encouraged to respect those requests where reasonable. [More considerations for the public](http://wiki.creativecommons.org/Considerations_for_licensors_and_licensees#Considerations_for_licensees). +Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible. + +**Using Creative Commons Public Licenses** -## Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International Public License +Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses. -By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions. +* __Considerations for licensors:__ Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. [More considerations for licensors](http://wiki.creativecommons.org/Considerations_for_licensors_and_licensees#Considerations_for_licensors). + +* __Considerations for the public:__ By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described. Although not required by our licenses, you are encouraged to respect those requests where reasonable. [More considerations for the public](http://wiki.creativecommons.org/Considerations_for_licensors_and_licensees#Considerations_for_licensees). + +## Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions. ### Section 1 – Definitions. a. __Adapted Material__ means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image. -b. __Copyright and Similar Rights__ means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. +b. __Adapter's License__ means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License. + +c. __BY-NC-SA Compatible License__ means a license listed at [creativecommons.org/compatiblelicenses](http://creativecommons.org/compatiblelicenses), approved by Creative Commons as essentially the equivalent of this Public License. + +d. __Copyright and Similar Rights__ means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. e. __Effective Technological Measures__ means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements. f. __Exceptions and Limitations__ means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material. +g. __License Elements__ means the license attributes listed in the name of a Creative Commons Public License. The License Elements of this Public License are Attribution, NonCommercial, and ShareAlike. + h. __Licensed Material__ means the artistic or literary work, database, or other material to which the Licensor applied this Public License. i. __Licensed Rights__ means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license. -h. __Licensor__ means the individual(s) or entity(ies) granting rights under this Public License. +j. __Licensor__ means the individual(s) or entity(ies) granting rights under this Public License. -i. __NonCommercial__ means not primarily intended for or directed towards commercial advantage or monetary compensation. For purposes of this Public License, the exchange of the Licensed Material for other material subject to Copyright and Similar Rights by digital file-sharing or similar means is NonCommercial provided there is no payment of monetary compensation in connection with the exchange. +k. __NonCommercial__ means not primarily intended for or directed towards commercial advantage or monetary compensation. For purposes of this Public License, the exchange of the Licensed Material for other material subject to Copyright and Similar Rights by digital file-sharing or similar means is NonCommercial provided there is no payment of monetary compensation in connection with the exchange. -j. __Share__ means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them. +l. __Share__ means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them. -k. __Sui Generis Database Rights__ means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world. +m. __Sui Generis Database Rights__ means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world. -l. __You__ means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning. +n. __You__ means the individual or entity exercising the Licensed Rights under this Public License. __Your__ has a corresponding meaning. ### Section 2 – Scope. @@ -46,7 +52,7 @@ a. ___License grant.___ A. reproduce and Share the Licensed Material, in whole or in part, for NonCommercial purposes only; and - B. produce and reproduce, but not Share, Adapted Material for NonCommercial purposes only. + B. produce, reproduce, and Share Adapted Material for NonCommercial purposes only. 2. __Exceptions and Limitations.__ For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions. @@ -58,7 +64,9 @@ a. ___License grant.___ A. __Offer from the Licensor – Licensed Material.__ Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License. - B. __No downstream restrictions.__ You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material. + B. __Additional offer from the Licensor – Adapted Material.__ Every recipient of Adapted Material from You automatically receives an offer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapter’s License You apply. + + C. __No downstream restrictions.__ You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material. 6. __No endorsement.__ Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i). @@ -76,9 +84,9 @@ Your exercise of the Licensed Rights is expressly made subject to the following a. ___Attribution.___ - 1. If You Share the Licensed Material, You must: + 1. If You Share the Licensed Material (including in modified form), You must: - A. retain the following if it is supplied by the Licensor with the Licensed Material: + A. retain the following if it is supplied by the Licensor with the Licensed Material: i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated); @@ -90,23 +98,31 @@ a. ___Attribution.___ v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; - B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and + B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and - C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License. - - For the avoidance of doubt, You do not have permission under this Public License to Share Adapted Material. + C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License. 2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information. 3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable. +b. ___ShareAlike.___ + +In addition to the conditions in Section 3(a), if You Share Adapted Material You produce, the following conditions also apply. + +1. The Adapter’s License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-NC-SA Compatible License. + +2. You must include the text of, or the URI or hyperlink to, the Adapter's License You apply. You may satisfy this condition in any reasonable manner based on the medium, means, and context in which You Share Adapted Material. + +3. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, Adapted Material that restrict exercise of the rights granted under the Adapter's License You apply. + ### Section 4 – Sui Generis Database Rights. Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material: -a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database for NonCommercial purposes only and provided You do not Share Adapted Material; +a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database for NonCommercial purposes only; -b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material; and +b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material, including for purposes of Section 3(b); and c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database. @@ -154,4 +170,4 @@ d. Nothing in this Public License constitutes or may be interpreted as a limitat > Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at [creativecommons.org/policies](http://creativecommons.org/policies), Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses. > -> Creative Commons may be contacted at [creativecommons.org](http://creativecommons.org). +> Creative Commons may be contacted at creativecommons.org \ No newline at end of file diff --git a/docs/index.md b/docs/advanced/commands-context.md similarity index 100% rename from docs/index.md rename to docs/advanced/commands-context.md diff --git a/docs/advanced/custom-interfaces.md b/docs/advanced/custom-interfaces.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/advanced/custom-run.md b/docs/advanced/custom-run.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/advanced/external-triggers.md b/docs/advanced/external-triggers.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/advanced/fallback-command.md b/docs/advanced/fallback-command.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/advanced/localization-and-multi-language.md b/docs/advanced/localization-and-multi-language.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/advanced/optimization.md b/docs/advanced/optimization.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/advanced/other.md b/docs/advanced/other.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/advanced/voice-assistant.md b/docs/advanced/voice-assistant.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/command-response.md b/docs/command-response.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/commands-context.md b/docs/commands-context.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/contributing-and-shared-usage-stark-place.md b/docs/contributing-and-shared-usage-stark-place.md new file mode 100644 index 0000000..f74edda --- /dev/null +++ b/docs/contributing-and-shared-usage-stark-place.md @@ -0,0 +1,10 @@ +# Contributing and Shared Usage + +[STARK-PLACE](https://github.com/MarkParker5/STARK-PLACE) repository is a platform library with community extensions. Use commands created by others and feel free to share yours! + + + + +### License + +Project is licensed under \ No newline at end of file diff --git a/docs/creating-commands.md b/docs/creating-commands.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/dependency-injection.md b/docs/dependency-injection.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/first-steps.md b/docs/first-steps.md new file mode 100644 index 0000000..669fd47 --- /dev/null +++ b/docs/first-steps.md @@ -0,0 +1 @@ +# First Steps \ No newline at end of file diff --git a/docs/home.md b/docs/home.md new file mode 100644 index 0000000..2dae225 --- /dev/null +++ b/docs/home.md @@ -0,0 +1,37 @@ +# Welcome to S.T.A.R.K. + +**Speech and Text Algorithmic Recognition Kit** + +Welcome to S.T.A.R.K., a modern, advanced, asynchronous, and fast framework designed for creating intuitive natural language interfaces, especially voice-based. Think of it as the [FastAPI](https://fastapi.tiangolo.com/) but with speech instead of http. + +New to S.T.A.R.K.? Consider reading the articles in navigation sequentially for a comprehensive understanding of the framework, including the "Advanced" section. + +--- + +### 🔍 Key Features: + +- **🛡️ Autonomous and Privacy-Focused**: Stark operates entirely on-device, ensuring your data remains private. Dive deeper into hosting options [here](/where-to-host). + +- **🧠 Context-Aware**: Easily define context and parameters for subsequent requests or parse multiple commands simultaneously. Discover the power of [Commands Context](/commands-context). + +- **🚀 Asynchronous Commands**: Start lengthy tasks and continue using Stark You'll be notified upon completion. Learn about [Sync vs Async Commands](/sync-vs-async-commands) and the intricacies of [Creating Commands](/creating-commands). + +- **📈 Multiple Responses**: Get real-time updates for long tasks, like monitoring download progress. More on this in [Creating Commands](/creating-commands). + +- **🧩 Advanced Patterns Parsing**: Our custom [patterns](/patterns) syntax makes parsing any parameter from strings effortless. + +- 🧠 **Extendable with LLMs**: Enhance Stark's cognition by integrating leading language models like ChatGPT. + +- 🌐 **Multilingual Support**: Interact with Stark in [multiple languages](/advanced/localization-and-multi-language). + +- **🔧 Absolute Customization**: Craft complex commands, integrate various speech or text interfaces, adapt voice assistant modes, or even override existing classes. + +- **🌍 Community Support**: Join [STARK-PLACE](https://github.com/MarkParker5/STARK-PLACE) repository, the platform library filled with community extensions. Utilize commands crafted by others and share your creations. Further information in [Contributing and Shared Usage](/contributing-and-shared-usage). + +--- + +### License + +The S.T.A.R.K. project is licensed under the [CC BY-NC-SA 4.0 International license](https://github.com/MarkParker5/STARK/tree/master/LICENSE.md). You're welcome to modify, contribute to the repository, create, and share forks. Just remember to attribute the original repository and its creator, abstain from commercial use, and retain the existing license. + +**Note**: Failing to provide the necessary attribution or using the project for commercial purposes breaches the licensing terms and could have legal consequences. diff --git a/docs/installation.md b/docs/installation.md new file mode 100644 index 0000000..4026317 --- /dev/null +++ b/docs/installation.md @@ -0,0 +1,2 @@ +# Installation + diff --git a/docs/patterns.md b/docs/patterns.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/sync-vs-async-commands.md b/docs/sync-vs-async-commands.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/voice-assistant.md b/docs/voice-assistant.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/where-to-host.md b/docs/where-to-host.md new file mode 100644 index 0000000..e69de29 diff --git a/mkdocs.yml b/mkdocs.yml index cc11fc1..3ed2093 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,7 +9,33 @@ repo_url: https://github.com/MarkParker5/STARK copyright: Copyright © Mark Parker -# nav: +nav: + - Home: home.md # Home, description, all features list, where to find commands, license, usefull links + - Contributing and Shared Usage: contributing-and-shared-usage.md # Contributing, shared usage, code of conduct, license + - Installation: installation.md + - First Steps: first-steps.md + - Sync vs Async Commands: sync-vs-async-commands.md # TLDR and in depth about worker threads and asyncify + - Creating Commands: creating-commands.md # manager.new, join managers, return, yield (async, sync), handler.respond and unrespond (sync and async), call subcommands (sync and async) + - Patterns: patterns.md # pattern syntax, parameters parsing, native types, custom object types, nested objects, advanced parsing with did_parse + - Command Response: command-response.md # every property explanation + - Dependency Injection: dependency-injection.md # response handler, inject_dependency, get DIContainer, add custom dependency, create a custom container + - Commands Context: commands-context.md # context explanation, adding context in response, pop context, multiple commands in request + - Voice Assistant: voice-assistant.md # Modes, repeating, context handling + - Default Speech Interfaces: # STT, TTS + - Where to Host: where-to-host.md # personal computer: system.d or windows tray, raspberry pi: system.d, iOS: in development, android: not implemented + - Advanced Usage: + - Optimization: advanced/optimization.md # worker threads, asyncify, asyncer group, caching + - Custom Run: advanced/custom-run.md # custom event loop, blocking detector, typer + - Fallback Command: advanced/fallback-command.md # Fallback command setting and available implementations + - External Triggers: advanced/external-triggers.md # external triggers + - Localization and Multi-Language: advanced/localization-and-multi-language.md # TODO: Localization, multi-language + - Custom Interfaces: advanced/custom-interfaces.md # stt, tts, text: telebot. + # - Speech Recognition: advanced/speech-recognition.md # available engines, create custom + # - Speech Synthesis: advanced/speech-synthesis.md # available engines, create custom + - Voice Assistant: advanced/voice-assistant.md # methods for overrides + - Commands Context: advanced/commands-context.md # methods for overrides + - Other: # read the code + theme: name: material diff --git a/pyproject.toml b/pyproject.toml index 9c26cbc..4e155c0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,9 +1,9 @@ [tool.poetry] name = "stark" -version = "0.1.0" +version = "4.0.0" description = "" authors = ["MarkParker5 "] -license = "CC BY-NC-ND 4.0" +license = "CC BY-NC-SA 4.0" readme = "README.md" packages = [{include = "stark"}]