Skip to content

Commit

Permalink
Restructure README file (#132)
Browse files Browse the repository at this point in the history
* Restructure README file
  • Loading branch information
FabienLelaquais authored Jan 25, 2023
1 parent 6ad3462 commit 0d10002
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 8 deletions.
62 changes: 54 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.<br/>
## 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.<br/>
**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.<br/>
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".

<p align="center">
<img src="doc/images/installation.gif" width=75%>
</p>

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:<br/>
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.<br/>
You can then select a configuration file to work on, adding and editing the configuration
items that your application can use.<br/>
See the complete documentation on
[Building Taipy configuration files](https://docs.taipy.io/en/latest/manuals/studio/config/)
for details.

- Creating Taipy GUI pages:<br/>
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.<br/>
See the complete documentation on
[Creating Taipy GUI pages](https://docs.taipy.io/en/latest/manuals/studio/gui/) for details.
Binary file added doc/images/installation.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0d10002

Please sign in to comment.