Skip to content

Commit 9ba15cd

Browse files
committed
Mark up with Markdown
1 parent c88e968 commit 9ba15cd

File tree

1 file changed

+22
-19
lines changed

1 file changed

+22
-19
lines changed

README.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,26 @@
1-
JRuby Native Launcher
1+
# JRuby Native Launcher
22

3-
== Motivation
3+
## Motivation
44

5-
Maintaning JRuby.BAT was, well, to put it mildly, unpleasant. We had
5+
Maintaning `JRuby.BAT` was, well, to put it mildly, unpleasant. We had
66
tens of bugs due to BAT limitations, we had weird behaviors depending
77
on the version of Windows, we had a bunch of regressions.
88

99
See http://jira.codehaus.org/browse/JRUBY-4100 for more details.
1010

1111
On UNIX platforms, we had problems because a shell-script can't be put
12-
as a path in the shebang and couldn't take arguments. (#!/usr/bin/env
13-
jruby -w)
12+
as a path in the shebang and couldn't take arguments. (`#!/usr/bin/env
13+
jruby -w`)
1414

1515
We also wanted to DRY up argument handling, even if it meant ditching
1616
shell script and writing in lowest-common-denominator C++ (!).
1717

18-
== Compile
18+
## Compile
1919

20-
On UNIX, you should be able to just type 'make' and a 'jruby' binary
20+
On UNIX, you should be able to just type `make` and a `jruby` binary
2121
will be created in the project directory. Copy this to
22-
$JRUBY_HOME/bin. On Windows, you should also be able to type 'make' if
22+
`$JRUBY_HOME/bin` (or wherever your `jruby` executable is installed). On
23+
Windows, you should also be able to type `make` if
2324
you have the MinGW compiler toolkit installed.
2425

2526
Or, open the project in Netbeans 6.8 (with C/C++ plugin installed). If
@@ -29,8 +30,10 @@ here:
2930

3031
http://netbeans.org/community/releases/68/cpp-setup-instructions.html
3132

32-
Then, just build it, and you're ready to go. jruby.exe, jrubyw.exe and
33-
jruby.dll will be created, they need to be copied into $JRUBY_HOME/bin
33+
Then, just build it, and you're ready to go. `jruby.exe`, `jrubyw.exe`
34+
and
35+
`jruby.dll` will be created, they need to be copied into
36+
`$JRUBY_HOME/bin`
3437
directory.
3538

3639
Both, 32-bit and 64-bit compilers are supported. Great version of
@@ -39,23 +42,23 @@ Both, 32-bit and 64-bit compilers are supported. Great version of
3942
To build 64-bit version of the launcher, use the following from the
4043
command line:
4144

42-
make CONF=mingw64
45+
make CONF=mingw64
4346

44-
== Run
47+
## Run
4548

4649
The launcher provides a great logger, use it like this:
4750

48-
jruby -Xtrace LOG_FILE.log ....
51+
jruby -Xtrace LOG_FILE.log ....
4952

50-
== TODO
53+
## TODO
5154

52-
See TODO.txt file for things that need to be done before this launcher
53-
could replace jruby.bat.
55+
See `TODO.txt` file for things that need to be done before this launcher
56+
could replace `jruby.bat`.
5457

55-
== Thanks
58+
## Thanks
5659

5760
The original code is by Netbeans project.
5861

59-
== License
62+
## License
6063

61-
Read the COPYING file.
64+
Read the `COPYING` file.

0 commit comments

Comments
 (0)