kuro
/
bmc-tpl-code-all-around
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases 7 Wiki Activity

Add Installation_en

kuro 2026-10-15 20:34:04 +00:00
parent ebadab793c
commit 4ad7b0a17f
1 changed files with 62 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
Installation_en.md Normal file

@ -0,0 +1,62 @@
# 🚀 Installation & Getting Started
This page guides you through the installation of the **BMC TPL Code All around** extension in Visual Studio Code and shows you how to get started immediately.
## 📦 Installation (The Easy Way)
Since the plugin is currently distributed via this repository, you can easily install it as a `.vsix` package (Visual Studio Extension).
1. Go to the **Releases** section in this repository.
2. Download the latest file with the `.vsix` extension (e.g., `bmc-tpl-code-all-around-0.0.1.vsix`).
3. Open Visual Studio Code.
4. Go to the Extensions section in the left sidebar (`Ctrl + Shift + X`).
5. Click on the three dots icon (`...`) in the top right corner of the Extensions menu and select **"Install from VSIX..."**.
6. Select the downloaded `.vsix` file.
7. Done! After a few seconds, VS Code will notify you that the extension was successfully installed.
*Alternatively, you can simply drag and drop the downloaded file into the Extensions view of Visual Studio Code. You can also perform manual updates this way.*
---
## 🛠️ Installation from Source (For Developers)
If you want to contribute to the extension yourself or test the latest (perhaps unreleased) version, you can compile it directly from the source code:
1. **Prerequisites:** You need Node.js and npm installed on your system.
2. **Clone the Repository:**
```bash
git clone https://wiccafe.de/kuro/bmc-tpl-code-all-around.git
cd bmc-tpl-code-all-around
npm install
```
3. **Compile & Run in VS Code:** Open the folder in VS Code. Simply press `F5`. A new VS Code window ("Extension Development Host") will open, with the plugin loaded and ready to use.
4. **Build your own VSIX:** If you want to package it yourself, use the command:
```bash
npm run package
```
*(Note: This requires vsce to be installed globally: `npm install -g @vscode/vsce`)*
---
## 🏁 First Steps
Once installed, the plugin activates automatically as soon as you open a file with the `.tpl` extension.
Here are three things you should try right away:
### 1. Generate the Skeleton
Create an empty file named `test.tpl`. Type the word `tpl`. The auto-completion should now suggest the snippet `tpl_skeleton`. Press `Enter` or `Tab` – and the complete module skeleton (including metadata, pattern, triggers, and a log statement) will be generated instantly!
### 2. Set Your Own Data
To avoid typing your name and company structure every time you generate new files:
1. Open the VS Code Settings (`Ctrl + ,` or via the gear icon in the bottom left).
2. Search for `TPL`.
3. Under **BMC TPL Settings**, enter your name (Author), the Publisher, and the start of your Tree-Path.
4. *Tip:* These settings are applied immediately without restarting the plugin!
### 3. Annoy the Linter
In your generated code, intentionally delete a semicolon at the end of a line or change an assignment from `:=` to a simple `=`. The intelligent linter should trigger immediately and mark the spot in red or yellow. If you hover over it with your mouse, it will explain exactly what is wrong.
---
**Ready for more?** Check out the [Features & Usage](Features-EN) in detail in the next step!