diff --git a/docs/reference/index.rst b/docs/reference/index.rst index d77e26a95..327c10dee 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -1,28 +1,14 @@ .. Copyright © SixtyFPS GmbH .. SPDX-License-Identifier: MIT -Getting Started -=============== +.. include:: src/introduction/index.rst -To use `Slint `_ you need to embed your slint files in a project written -in a supported programming language, like C++, Rust, or JavaScript. +.. toctree:: + :hidden: + :maxdepth: 2 + :caption: Introduction -There are three different pathways to get started with Slint: - -1. `SlintPad `_ - Use this to get a feel of the Slint language. - This is a web browser-based tool where you can try Slint out. - -2. As a UI Designer, working with Slint files locally, we recommend the following combination of software tools: - - - `Visual Studio Code `_ - - `The Slint for Visual Studio Code Extension `_ - -3. As a Software Developer, integrating Slint into a new or existing code base, choose one of these languages to - get started: - - - `C++ `_ - - `Rust `_ - - `JavaScript `_ + src/introduction/index.rst .. toctree:: :hidden: diff --git a/docs/reference/src/introduction/index.rst b/docs/reference/src/introduction/index.rst new file mode 100644 index 000000000..9f0650db9 --- /dev/null +++ b/docs/reference/src/introduction/index.rst @@ -0,0 +1,25 @@ +.. Copyright © SixtyFPS GmbH +.. SPDX-License-Identifier: MIT + +Getting Started +=============== + +To use `Slint `_ you need to embed your slint files in a project written +in a supported programming language, like C++, Rust, or JavaScript. + +There are three different pathways to get started with Slint: + +1. `SlintPad `_ - Use this to get a feel of the Slint language. + This is a web browser-based tool where you can try Slint out. + +2. As a UI Designer, working with Slint files locally, we recommend the following combination of software tools: + + - `Visual Studio Code `_ + - `The Slint for Visual Studio Code Extension `_ + +3. As a Software Developer, integrating Slint into a new or existing code base, choose one of these languages to + get started: + + - `C++ `_ + - `Rust `_ + - `JavaScript `_