First Steps chapter rewritten and rephrased. (#112)

* First chapters rewritten and rephrased.

* Cleanup of the pics which are not used.

* Fixed command line options path and chapter name

* Fix contributing.md

* Fix quarto and updated credits

* Fixed comments

* Fix example

* renamed command_format.md to commandline_rizin.md

* Fix quarto compilation and colors

* Fix comment

* Rewrite of the whole rizin command line section

* Update git workflow.

* Updated covers and removed old stuff

* Fix latex char issue.

* Mention `Vv`

* Add /site_libs/ in .gitignore

* Updated Expressions chap

* Refactor debugger session examples

.github/workflows/mdbook.yml

@@ -1,29 +1,47 @@
 name: Publish to GitHub Pages
-
 on:
   push:
     branches:
       - master
+      - dev
   pull_request:
     branches:
       - master
+      - dev
+
 jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - name: Check out repository
+        uses: actions/checkout@v4
 
-      - name: Install Quarto and render
-        uses: pommevilla/quarto-render@main
+      - name: Set up Quarto
+        uses: quarto-dev/quarto-actions/setup@v2
+        with:
+          tinytex: true
+
+      - name: Render Book project in HTML
+        uses: quarto-dev/quarto-actions/render@v2
+        with:
+          to: html
 
-      - name: Deploy
-        if: github.event_name == 'push'
+      - name: Deploy Stable
+        if: github.event_name == 'push' && github.ref == 'refs/heads/master'
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: docs
           cname: book.rizin.re
 
+      - name: Deploy Dev
+        if: github.event_name == 'push' && github.ref == 'refs/heads/dev'
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs
+          cname: book-dev.rizin.re
+
       - name: Render to PDF and ePub
         shell: bash
         run: |

.gitignore

@@ -9,5 +9,8 @@ _book/*
 .*.swo
 *.un~
 *.snippets
-
+*.html
+index.log
+index.tex
 /.quarto/
+/site_libs/

_quarto.yml

@@ -4,10 +4,10 @@ project:
 
 book:
   reader-mode: true
-  title: "The Official Rizin Book"
+  title: "The Rizin Handbook: A Guide to Reverse Engineering with the Rizin Framework"
   author: "Rizin Organization"
   description: |
-    This is a book about the Rizin reverse engineering framework
+    This book focuses on the Rizin reverse engineering framework
   site-url: https://book.rizin.re/
   repo-url: https://github.com/rizinorg/book
   repo-branch: master
@@ -26,8 +26,8 @@ book:
       - part: "First Steps"
         chapters:
          - src/first_steps/intro.md
-         - src/first_steps/commandline_flags.md
-         - src/first_steps/command_format.md
+         - src/first_steps/commandline_options.md
+         - src/first_steps/commandline_rizin.md
          - src/first_steps/expressions.md
          - src/first_steps/basic_debugger_session.md
          - src/first_steps/contributing.md

book.toml

@@ -1,7 +1,7 @@
 [book]
-title = "The Official Rizin Book"
-author = "pancake <[email protected]>"
-description = "The Official Rizin Book"
+title = "The Rizin Handbook: A Guide to Reverse Engineering with the Rizin Framework"
+author = "Rizin Organization"
+description = "This book focuses on the Rizin reverse engineering framework"
 
 [build]
 create-missing = false

index.md

@@ -1,20 +1,18 @@
 ## Welcome {.unnumbered}
 
-This is a book about Rizin reverse engineering framework and it's originally based on the radare2 book
+This book covers the Rizin reverse engineering framework.
 
-Check the Github site to add new contents or fix typos:
+Visit the links below to contribute new content or address any typos that might be present in this book.
 
     Github: https://github.com/rizinorg/book
     Online: https://book.rizin.re/
 
 ## Offline
 
-The ePub and PDF versions of the Rizin book are avaiable for offline use and it can be found under the
-section 'Artifacts' on the [Github Actions CI](https://github.com/rizinorg/book/actions/).
+The ePub and PDF versions of the Rizin book are accessible for offline use, and you can locate them in the 'Artifacts' section on the [GitHub Actions CI](https://github.com/rizinorg/book/actions/) page.
 
-This book can also be read offline by cloning the repository and rendering it using
-[quarto](https://quarto.org).
+This book can also be read offline by cloning the repository and rendering it using [quarto](https://quarto.org).
 
 `$ quarto render /path/to/rizin-book/`
 
-The static HTML files will be generated in a folder named `docs`.
+The static HTML files will be generated in a folder named `docs`.

src/SUMMARY.md

@@ -7,8 +7,8 @@
    * [Compilation on Windows](first_steps/windows_compilation.md)
    * [Compilation on Android](first_steps/compilation_android.md)
 * [First Steps](first_steps/intro.md)
-   * [Command-line Flags](first_steps/commandline_flags.md)
-   * [Command Format](first_steps/command_format.md)
+   * [Shell Command-line Options](first_steps/commandline_options.md)
+   * [Rizin Command-line](first_steps/commandline_rizin.md)
    * [Expressions](first_steps/expressions.md)
    * [Basic Debugger Session](first_steps/basic_debugger_session.md)
    * [Contributing to rizin](first_steps/contributing.md)

src/basic_commands/block_size.md

@@ -50,4 +50,4 @@ Another way around is to use special variables `$FB` and `$FS` which denote Func
 ╰           0x00001f97      c3                 ret
 ```
 
-Note: don't put space after `!` size designator. See also [Command Format](../first_steps/command_format.md).
+Note: don't put space after `!` size designator. See also [Rizin Command-line](../first_steps/commandline_rizin.md).

src/basic_commands/intro.md

@@ -2,7 +2,7 @@
 
 Most command names in rizin are derived from action names. They should be easy to remember, as they are short. Actually, all commands are single letters. Subcommands or related commands are specified using the second character of the command name. For example, `/ foo` is a command to search plain string, while `/x 90 90` is used to look for hexadecimal pairs.
 
-The general format for a valid command (as explained in the [Command Format](../first_steps/command_format.md) chapter) looks like this:
+The general format for a valid command (as explained in the [Rizin Command-line](../first_steps/commandline_rizin.md) chapter) looks like this:
 
 ```
 [.][times][cmd][~grep][@[@iter]addr!size][|>pipe] ; ...

src/basic_commands/print_modes.md

@@ -64,7 +64,7 @@ Tip: when using json output, you can append the `~{}` to the command to get a pr
 ]
 ```
 
-For more on the magical powers of `~` see the help in `?@?`, and the [Command Format](../first_steps/command_format.md) chapter earlier in the book.
+For more on the magical powers of `~` see the help in `?@?`, and the [Rizin Command-line](../first_steps/commandline_rizin.md) chapter earlier in the book.
 
 ### Hexadecimal View
 

src/credits/credits.md

@@ -1,83 +1,134 @@
 ## Authors & Contributors
 
-This book wouldn't be possible without the help of a large list of contributors who have been reviewing, writing and reporting bugs and stuff in the rizin project as well as in this book.
+The creation of this book owes much to the extensive list of contributors who have played a crucial role in reviewing, writing, and reporting bugs within the Rizin project and this book. Heartfelt thanks to everyone who has been actively engaged in the development of the book:
 
-### The rizin book
-
-This book was started by maijin as a new version of the original radare1 book written by pancake. It was updated and reworked significantly for the radare2.
-With the rizin fork the book has been reworked again.
-
-* Old radare2 book [https://book.rada.re](https://book.rada.re)
-
-Many thanks to everyone who has been involved with the gitbook:
-
-Adrian Studer,
-Ahmed Mohamed Abd El-MAwgood,
-Akshay Krishnan R,
-Andrew Hoog,
-Anton Kochkov,
-Antonio Sánchez,
-Austin Hartzheim,
-Aswin C (officialcjunior),
-Bob131,
-DZ_ruyk,
-David Tomaschik,
-Eric,
-Fangrui Song,
-Francesco Tamagni,
-FreeArtMan,
-Gerardo García Peña,
-Giuseppe,
-Grigory Rechistov,
-Hui Peng,
-ITAYC0HEN,
-Itay Cohen,
-Jeffrey Crowell,
-John,
-Judge Dredd (key 6E23685A),
-Jupiter,
-Kevin Grandemange,
-Kevin Laeufer,
-Luca Di Bartolomeo,
-Lukas Dresel,
-Maijin,
-Michael Scherer,
-Mike,
-Nikita Abdullin,
-Paul,
-Paweł Łukasik,
-Peter C,
-RandomLive,
-Ren Kimura,
-Reto Schneider,
-SchumBlubBlub,
-SkUaTeR,
-Solomon,
-Srimanta Barua,
-Sushant Dinesh,
-TDKPS,
-Thanat0s,
-Vanellope,
-Vex Woo,
-Vorlent,
-XYlearn,
-Yuri Slobodyanyuk,
-ali,
-aoighost,
-condret,
-hdznrrd,
-izhuer,
-jvoisin,
-kij,
-madblobfish,
-muzlightbeer,
-pancake,
-polym (Tim),
-puddl3glum,
-rizin,
-sghctoma,
-shakreiner,
-sivaramaaa,
-taiyu,
-vane11ope,
-xarkes.
+7flying
+8dcc
+Adrian Studer
+aemmitt-ns
+Agustín Dall'Alba
+Ahmed Mohamed Abd El-MAwgood
+Akshay Krishnan R
+Alba Mendez
+Ali Raheem
+Andrew Hoog
+Anton Kochkov
+Antonio Sánchez
+aoighost
+Aswin C
+Austin Hartzheim
+bemojo2021
+Bob131
+Braiden Kindt
+chucklesb
+ckanibal
+condret
+Connor Armand Du Plooy
+Cyrill Leutwiler
+David Tomaschik
+Deepak Chethan
+Dennis Goodlett
+Dennis van der Schagt
+Dhruv Maroo
+Dhruva Gole
+dodococo
+dreamist
+DZ_ruyk
+Eric
+Fangrui Song
+Florian Best
+Francesco Tamagni
+FreeArtMan
+Gerardo García Peña
+Giuseppe
+gogo2464
+GPery
+grepharder
+Grigory Rechistov
+GustavoLCR
+h0pp
+hdznrrd
+Heersin
+hmht
+Hui Peng
+Itay Cohen
+ivan tkachenko
+izhuer
+Jacob Rosenthal
+Jeffrey Crowell
+John
+jones martin
+Judge Dredd
+Jupiter
+jvoisin
+Kali Kaneko
+karliss
+Kevin Grandemange
+Kevin Laeufer
+Khairul Azhar Kasmiran
+kij
+krmpotic
+Lev Aronsky
+Liumeo
+lowsec
+Luca Di Bartolomeo
+Lukas Dresel
+madblobfish
+Maijin
+Martin Brunner
+Masterfox
+meowmeowxw
+Michael Scherer
+Mike
+mrmacete
+ms111ds
+muzlightbeer
+Nikita Abdullin
+officialcjunior
+pancake
+Paul I
+Paweł Łukasik
+Peter C
+polym (Tim)
+puddl3glum
+Pulak Malhotra
+Rafael Rivera
+ralexe
+RandomLive
+ratijas
+Razvan Ioan Alexe
+Ren Kimura
+Reto Schneider
+Riccardo Schirone
+Roman Valls Guimera
+Rot127
+Ryan Geary
+Sandra Bino
+SchumBlubBlub
+seanachao
+sghctoma
+shakreiner
+sivaramaaa
+SkUaTeR
+Solomon
+Sophie Chen
+Srimanta Barua
+Surendrajat
+Sushant Dinesh
+taiyu
+TDKPS
+Thanat0s
+tick
+Tomasz Różański
+Tomáš Golembiovský
+Tristan
+Vanellope
+Vex Woo
+Vorlent
+wargio
+xarkes
+XYlearn
+yossizap
+Yuri Slobodyanyuk
+Zi Fan
+Óscar Carrasco