You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This repository contains the latest free and open edition of The BEAM Book,
9
+
a deep dive into the internals of the Erlang runtime system and its virtual
10
+
machine, the BEAM.
9
11
10
-
Grab the tree‑ware from your local Amazon store:
12
+
The current open edition is **1st Edition** (2025), licensed under CC BY 4.0.
11
13
12
-
* 🇺🇸 [US](https://www.amazon.com/dp/9153142535)
13
-
* 🇬🇧 [UK](https://www.amazon.co.uk/dp/9153142535)
14
-
* 🇩🇪 [DE](https://www.amazon.de/dp/9153142535)
15
-
* 🇸🇪 [SE](https://www.amazon.se/dp/9153142535)
14
+
You can read the book as a [PDF](https://github.com/happi/theBeamBook/releases/latest),
15
+
[browse it online](https://happi.github.io/theBeamBook/), or read the
16
+
AsciiDoc source directly on GitHub starting from [book.asciidoc](book.asciidoc).
16
17
17
-
This project documents the internals of the Erlang runtime system and its virtual machine, the **BEAM**.
18
+
The printed edition is available on Amazon:
19
+
[US](https://www.amazon.com/dp/9153142535) |
20
+
[UK](https://www.amazon.co.uk/dp/9153142535) |
21
+
[DE](https://www.amazon.de/dp/9153142535) |
22
+
[SE](https://www.amazon.se/dp/9153142535)
18
23
19
-
You can read or download the book as a PDF (current stable release **1.0 – First Edition**) from the [latest stable release](https://github.com/happi/theBeamBook/releases/latest) or [browse it online](https://happi.github.io/theBeamBook/).
24
+
## Edition Policy
20
25
21
-
The book is written in AsciiDoc and most chapters can be read directly from source on GitHub. Open [book.asciidoc](book.asciidoc) for a quick start.
26
+
This book follows a rolling open model.
22
27
23
-
You can also read it as a [GitHub Pages site](https://happi.github.io/theBeamBook/).
28
+
- The newest edition is published commercially.
29
+
- The previous edition is released publicly in this repository.
30
+
- Over time, all major editions become open.
31
+
32
+
This means the open version may lag behind the latest printed edition.
33
+
The open version is stable and complete, but may not contain the newest
34
+
chapters or revisions.
24
35
25
36
## Contributing
26
37
27
-
The goal is a collaborative, authoritative reference on the Erlang runtime system. Please contribute—this work is far from complete.
38
+
Contributions are welcome. Raise an issue, comment on open threads, or
39
+
open a pull request.
28
40
29
-
* Raise an issue, comment on open threads, or open a pull request.
30
-
* All contributions fall under the project’s Creative Commons licence (see below).
41
+
By submitting a pull request, you agree that your contribution is licensed
42
+
under the same license as this repository (CC BY 4.0). Contributions may
43
+
appear in future commercial editions of the book with attribution.
31
44
32
45
Each chapter can be in one of four states:
33
46
34
-
1.**Placeholder** — only a title and maybe an outline. Grab the matching issue and start writing.
35
-
2.**First draft** — the text is mostly there but needs editing: missing content, clarity, diagram tweaks, etc.
36
-
3.**Final draft** — typo‑hunting and polishing.
37
-
4.**Done (for OTP X)** — until a newer OTP version changes things.
47
+
1.**Placeholder** -- only a title and maybe an outline.
48
+
2.**First draft** -- the text is mostly there but needs editing.
49
+
3.**Final draft** -- typo-hunting and polishing.
50
+
4.**Done (for OTP X)** -- until a newer OTP version changes things.
51
+
52
+
For larger rewrites, check the chapter's status and existing issues.
53
+
Coordinate with any active authors before heavy edits.
38
54
39
55
### Style guide
40
56
@@ -44,164 +60,74 @@ AsciiDoc constructs should render nicely in this order of priority:
44
60
2. HTML output
45
61
3. Direct view on GitHub
46
62
47
-
We’ll accumulate specific do’s and don’ts here as we learn what works.
48
-
49
-
#### Comments in AsciiDoc
63
+
#### Linking to OTP source code
50
64
51
-
Each chapter starts with a comment marking its status (`// Placeholder`, `// First Draft`, etc.) and possibly a link to an issue that tracks next steps.
0 commit comments