Skip to content

Commit 0ac05eb

Browse files
committed
Added From source section to README.md
1 parent 9800f72 commit 0ac05eb

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ A fast, robust command-line parser, formatter, and editor for JBeam files, the J
2828
Uniform indentation, spacing, and layout for improved readability.
2929

3030
- **Automatic Node Management:**
31-
Renames nodes sequentially (e.g., `["bf1", ...]``["bf0", "bf1", "bf2"]`) and updates all references automatically.
31+
Renames nodes sequentially (e.g., `["bf1", ...]``["bf0", "bf1", "bf2"]`) and updates all references automatically. Feature currently unstable, enabled by build flag `transformation`.
3232

3333
- **Configurable Formatting with JBFL:**
3434
Customize formatting rules using JBFL, a mini-language to specify padding, decimals, indentation, and more with wildcard targeting.
@@ -107,6 +107,18 @@ In-place editing (no backup):
107107
jbeam-edit -i example.jbeam
108108
```
109109

110+
### From source (Linux or development)
111+
112+
Clone and build with Cabal:
113+
114+
```bash
115+
git clone https://github.com/webdevred/jbeam_edit.git
116+
cd jbeam_edit
117+
cabal update
118+
cabal install
119+
jbeam-edit your-file.jbeam
120+
```
121+
110122
## Examples
111123

112124
For sample `.jbeam` files and JBFL rule files, see the [Examples Directory README](examples/README.org).
@@ -138,8 +150,10 @@ For an in-depth walkthrough of the implementation and design decisions, see [EXP
138150

139151
## Prerequisites
140152

141-
- GHC (The Glasgow Haskell Compiler)
142-
- Stack build tool
153+
- **Windows users (BeamNG players):** none, just download the installer from [Releases](https://github.com/webdevred/jbeam_edit/releases/latest).
154+
- **Developers / Linux users:**
155+
- [GHC](https://www.haskell.org/ghc/) (Glasgow Haskell Compiler)
156+
- [Cabal](https://www.haskell.org/cabal/) build tool (comes with GHCup)
143157

144158
## Contributing & License
145159

0 commit comments

Comments
 (0)