diff --git a/README.md b/README.md index e38eb62..70889c3 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,58 @@ # Taipy Studio -Taipy Studio is ultimately an application that allows for creating Taipy applications -reducing the code that needs to be manually created. +[Taipy Studio](https://marketplace.visualstudio.com/items?itemName=Taipy.taipy-studio) +provides a set of tools that accelerate the creation of [Taipy](https://www.taipy.io/) +applications, reducing the code that needs to be manually written. -This application builder comes with predefined features that greatly accelerate -the development of applications that rely on Taipy Core. +Taipy Studio is an extension to [Visual Studio Code](https://code.visualstudio.com/), which +provides a whole development environment, including state-of-the-art support for the Python +programming language. -Taipy Studio depends on [Visual Studio Code](https://code.visualstudio.com/) which provides a -full development environment, including state-of-the-art support for the Python programming -language. The Taipy-specific functionality is provided as a Visual Studio Code extension, -which this repository holds the source code.
\ No newline at end of file +## Extensions included + +Taipy Studio automatically installs two extensions: + +* [Taipy Studio Configuration Builder](https://marketplace.visualstudio.com/items?itemName=Taipy.taipy-studio-config) - + Provides a point-and-click edition environment to create and modify Taipy configuration + files. +* [Taipy Studio GUI Helper](https://marketplace.visualstudio.com/items?itemName=Taipy.taipy-studio-gui) - + Provides support for the extended Markdown syntax used in Taipy GUI. This includes IntelliSense on + visual element properties, code navigation, variable explorer, and more.
+ **Taipy API Support: 2.0+** + +## Quick start + + 1. Install [Taipy](https://pypi.org/project/taipy/) version 2.0 or above on your system. + 1. Install the [Taipy Studio](https://marketplace.visualstudio.com/items?itemName=Taipy.taipy-studio) + extension.
+ You can look at the [Extension Marketplace](https://code.visualstudio.com/docs/editor/extension-marketplace) + page on how to install the extension. Look for extensions whose names contain "Taipy". + +

+ +

+ +You can now start building your Taipy application with specific tools that will +make your team and yourself far more productive! + +## Moving forward + +Taipy Studio can be used in two main scenarios: + +- Building Taipy configuration files:
+ If you plan to build Taipy configuration files, you can open the "Taipy Configs" view + and get started. This view opens in the *Secondary Side Bar". + + If your current project has any configuration files (`*.toml`), they are listed in + the "Config Files" section at the top of this view.
+ You can then select a configuration file to work on, adding and editing the configuration + items that your application can use.
+ See the complete documentation on + [Building Taipy configuration files](https://docs.taipy.io/en/latest/manuals/studio/config/) + for details. + +- Creating Taipy GUI pages:
+ If you edit a Markdown source file (`*.md`) or a string in a Python source file (`*.py`), + Taipy Studio will provide you with support for the Taipy GUI syntax.
+ See the complete documentation on + [Creating Taipy GUI pages](https://docs.taipy.io/en/latest/manuals/studio/gui/) for details. diff --git a/doc/images/installation.gif b/doc/images/installation.gif new file mode 100644 index 0000000..45a7383 Binary files /dev/null and b/doc/images/installation.gif differ