diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 00000000..50ca7766 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,9 @@ +{ + "recommendations": [ + "ms-vscode-remote.remote-containers", + "ms-vscode.cpptools-themes", + "ms-vscode.cpptools", + "ms-vscode.cpptools-extension-pack", + "twxs.cmake" + ] +} \ No newline at end of file diff --git a/docs/3-installation.md b/docs/2-installation.md similarity index 94% rename from docs/3-installation.md rename to docs/2-installation.md index 0e1b8fc8..9ee3cc2a 100644 --- a/docs/3-installation.md +++ b/docs/2-installation.md @@ -8,8 +8,6 @@ The following compilers (or newer) are supported: The library provides many options for reuse, and the most suitable approach depends on your specific requirements. -If you want to swiftly open an integrated development environment (IDE), begin coding to explore the library, and ensure seamless execution and compilation, the most efficient solution for you would be to open the [Quetzal Starter template for Visual Studio Code](#starter-template-vsc). - @tableofcontents ## Structure and Dependencies @@ -42,6 +40,21 @@ There are two entry points: --- +### Easiest: DevContainer on Visual Studio Code + +The easiest option to try out the project. + +To swiftly open an integrated development environment (IDE), begin coding to explore the library, and ensure seamless execution and compilation, the most efficient solution is the following: + +1. [Install Visual Studio Code](https://code.visualstudio.com/download) +2. [Install Docker Desktop](https://docs.docker.com/desktop/) +3. Open Docker and leave it active in the background +4. Click [here](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/Quetzal-framework/quetzal-CoaTL) to get started. + +This will download the project, builds a Docker Image, manage the dependencies and automatically buil and run the tests. If it's the first time you build the image, it may take some time, so you're free to go get a coffee! + +--- + ### Copy Since Quetzal-CoaTL is a header-only library, you can copy-paste the `./src` subdirectory diff --git a/docs/4-include.md b/docs/3-include.md similarity index 100% rename from docs/4-include.md rename to docs/3-include.md diff --git a/docs/5-tutorials.md b/docs/4-tutorials.md similarity index 100% rename from docs/5-tutorials.md rename to docs/4-tutorials.md diff --git a/docs/2-abstract.md b/docs/drafts/2-abstract.md similarity index 100% rename from docs/2-abstract.md rename to docs/drafts/2-abstract.md diff --git a/docs/quetzal-coaltl-fa-1200x627.png b/docs/quetzal-coaltl-fa-1200x627.png new file mode 100644 index 00000000..bff9a179 Binary files /dev/null and b/docs/quetzal-coaltl-fa-1200x627.png differ