@@ -64,15 +64,37 @@ Override per project by placing `.jbeam_edit.jbfl` in your project root.
64
64
65
65
## Usage
66
66
67
- Build and run:
67
+ ### 1. Download the latest release
68
+ Go to the [ Releases page] ( https://github.com/webdevred/jbeam_edit/releases ) and download the most recent ** ` .zip ` ** file.
68
69
69
- ``` bash
70
- git clone https://github.com/webdevred/jbeam-tool.git
71
- cd jbeam-tool
72
- stack build
73
- stack exec jbeam-tool -- [options] < input-file>
70
+ ### 2. Unzip the file
71
+ Extract the contents of the downloaded ` .zip ` archive to a folder of your choice.
72
+
73
+ ### 3. Run the setup as Administrator
74
+
75
+ Inside the extracted folder, right-click on ** setup.exe** and choose ** Run as administrator** .
76
+
77
+ ## 4. Allow Windows protection if needed
78
+ If Windows shows a warning such as:
79
+
80
+ > * Windows protected your PC*
81
+
82
+ Click ** More info** → ** Run anyway** .
83
+
84
+ ## 5. Open Command Prompt or PowerShell
85
+
86
+ Press ** Win + R** , type ` cmd ` (or ` powershell ` ), and press ** Enter** .
87
+
88
+ ## 6. Run jbeam-edit on a file
89
+
90
+ Navigate to your project in CMD:
91
+
92
+ ``` powershell
93
+ jbeam-edit your-file.jbeam
74
94
```
75
95
96
+ Replace ` your-file.jbeam ` with the path to the JBeam file you want to format.
97
+
76
98
Typical workflow:
77
99
78
100
- Parses and formats the file.
@@ -81,7 +103,7 @@ Typical workflow:
81
103
82
104
In-place editing (no backup):
83
105
84
- ``` bash
106
+ ``` powershell
85
107
jbeam-edit -i example.jbeam
86
108
```
87
109
0 commit comments