Skip to content

Commit 73a539a

Browse files
committed
Convert to README.md
1 parent 58cdda3 commit 73a539a

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

README.adoc renamed to README.md

+27-27
Original file line numberDiff line numberDiff line change
@@ -1,84 +1,84 @@
1-
= README =
2-
:guides: http://tldp.org/guides.html
3-
:license: https://github.com/pmarinov/bash-scripting-guide/blob/master/LICENSE.txt
4-
:pollen: https://docs.racket-lang.org/pollen/index.html
1+
# README
2+
:license:
3+
:pollen:
54

65
*Advanced Bash-Scripting Guide*
76
(New Edition based on Pollen)
87

9-
Advanced Bash-Scripting Guide in HTML: +
8+
Advanced Bash-Scripting Guide in HTML:
109
https://hangar118.sdf.org/p/bash-scripting-guide/
1110

12-
Home page: +
13-
https://hangar118.sdf.org/p/bash-scripting-guide-home/
11+
Home page: https://hangar118.sdf.org/p/bash-scripting-guide-home/
1412

15-
== About ==
13+
# About
1614

17-
The _Advanced Bash-Scripting Guide_ is a book written by Mendel Cooper
18-
and part of The Linux Documentation Project, page
19-
{guides}[Guides]. *This is a fork* of the original work which itself
20-
had been (since 2014) dedicated to the *Public Domain*.
15+
The *Advanced Bash-Scripting Guide* is a book written by Mendel Cooper
16+
and part of The Linux Documentation Project (see
17+
[Guides](http://tldp.org/guides.html)). **This is a fork** of the
18+
original work which itself had been (since 2014) dedicated to the
19+
**Public Domain**.
2120

2221
Motivation for the new edition:
2322

2423
* To produce a modern-looking HTML format
2524
* To produce a GNU Info format, readable inside Emacs
26-
* To use Pollen as a publishing system, see {pollen}["Pollen: the book
27-
is a program"]
25+
* To use Pollen as a publishing system, see ["Pollen: the book
26+
is a program"](https://docs.racket-lang.org/pollen/index.html)
2827
* To invite contributions by hosting on GitHub
2928

3029
== How to build ==
3130

3231
Use `apt` to install `racket`:
3332

34-
....
33+
```
3534
$ apt install racket
3635
3736
$ racket --version
38-
....
37+
```
3938

4039
Racket v7.0 is minimum
4140

4241
Use `raco pkg` to install Pollen:
4342

44-
....
43+
```
4544
$ raco pkg install pollen
46-
....
45+
```
4746

4847
Installs in `~/.racket/7.2/pkgs`
4948

5049
To read the documentation:
5150

52-
....
51+
```
5352
$ raco docs pollen
54-
....
53+
```
5554

5655
Also the book "Pollen: the book is a program" is at:
5756
`~/.racket/7.2/pkgs/pollen/pollen/doc/pollen/index.html`
5857

5958
One more package:
6059

61-
....
60+
```
6261
$ raco pkg install debug
63-
....
62+
```
6463

6564
Install `makeinfo`
6665

67-
....
66+
```
6867
$ apt install texinfo
69-
....
68+
```
7069

7170
Now build the project via `make`:
7271

73-
....
72+
```
7473
$ make all
75-
....
74+
```
7675

7776
TODO: Describe output folders
7877

7978
== License ==
8079

81-
Public Domain, see {license}[LICENSE.txt]
80+
Public Domain, see
81+
[LICENSE.txt](https://github.com/pmarinov/bash-scripting-guide/blob/master/LICENSE.txt)
8282

8383
== Changelog ==
8484

0 commit comments

Comments
 (0)