Skip to content

Commit

Permalink
feat: devcontainer should be ok
Browse files Browse the repository at this point in the history
  • Loading branch information
Becheler committed Nov 30, 2023
1 parent 687524c commit 963482d
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 2 deletions.
9 changes: 9 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"recommendations": [
"ms-vscode-remote.remote-containers",
"ms-vscode.cpptools-themes",
"ms-vscode.cpptools",
"ms-vscode.cpptools-extension-pack",
"twxs.cmake"
]
}
17 changes: 15 additions & 2 deletions docs/3-installation.md → docs/2-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
Binary file added docs/quetzal-coaltl-fa-1200x627.png
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 963482d

Please sign in to comment.