Skip to content

Commit 085696e

Browse files
committed
minor README change
1 parent 3a298b8 commit 085696e

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -138,10 +138,11 @@ $ jpm run --verbose debug # Passes '--verbose debug' to the run action
138138
Actions support several variable substitution features for cross-platform compatibility:
139139
140140
- **`{{deps}}`** - Replaced with the full classpath of all dependencies
141-
- **`{/}`** - Replaced with the file separator (`\` on Windows, `/` on Unix)
142-
- **`{:}`** - Replaced with the path separator (`;` on Windows, `:` on Unix)
141+
- **`{/}`** - Replaced with the file separator (`\` on Windows, `/` on Linux/Mac)
142+
- **`{:}`** - Replaced with the path separator (`;` on Windows, `:` on Linux/Mac)
143+
- **`{~}`** - Replaced with the user's home directory (The actual path on Windows, `~` on Linux/Mac)
143144
- **`{./path/to/file}`** - Converts relative paths to platform-specific format
144-
- **`{~/path/to/file}`** - Converts home directory paths to platform-specific format
145+
- **`{./libs:./ext:~/usrlibs}`** - Converts entire class paths to platform-specific format
145146
146147
Example with cross-platform compatibility:
147148
@@ -152,9 +153,11 @@ actions:
152153
test: "java -cp {{deps}}{:}{./target/classes} org.junit.runner.JUnitCore TestSuite"
153154
```
154155
155-
### Performance Optimization
156+
NB: The `{{deps}}` variable substitution is only performed when needed - if your action doesn't contain `{{deps}}`, jpm won't resolve the classpath, making execution faster for simple actions that don't require dependencies.
156157
157-
The `{{deps}}` variable substitution is only performed when needed - if your action doesn't contain `{{deps}}`, jpm won't resolve the classpath, making execution faster for simple actions that don't require dependencies.
158+
NB2: These actions are just a very simple convenience feature. For a much more full-featured cross-platform action runner I recommend taking a look at:
159+
160+
- [Just](https://github.com/casey/just) - Just a command runner
158161
159162
## Installation
160163

0 commit comments

Comments
 (0)