Skip to content

Commit

Permalink
Minor fixes here and there
Browse files Browse the repository at this point in the history
  • Loading branch information
radare committed Aug 29, 2023
1 parent ba07048 commit bffd395
Show file tree
Hide file tree
Showing 7 changed files with 50 additions and 19 deletions.
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -54,5 +54,6 @@ gmi: $(MD2GMI)
mkdir -p gmi
for a in $(shell find src -type d) ; do b=`echo $$a |sed -e 's,src/,gmi/,'`; mkdir -p $$b ; done
for a in $(shell find src | grep md$$) ; do b=`echo $$a |sed -e 's,src/,gmi/,' -e 's,md$$,gmi,'` ; $(MD2GMI) -o $$b < $$a; done
cp -f gmi/intro.gmi gmi/index.gmi

.PHONY: gmi
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ This book is an updated version (started by maijin) of the original
radare1 book (written by pancake). Please contribute by updating and
improving the contents.

* Github: [https://github.com/radareorg/radare2-book](https://github.com/radareorg/radare2-book)
* Online: [https://book.rada.re/](https://book.rada.re/)
* [Github](https://github.com/radareorg/radare2-book)
* [Read it Online](https://book.rada.re/)


[![mdbook](https://github.com/radareorg/radare2-book/actions/workflows/mdbook.yml/badge.svg)](https://github.com/radareorg/radare2-book/actions/workflows/mdbook.yml)
Expand Down
8 changes: 8 additions & 0 deletions md2gmi.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { md2gemini } from "gemdown";

const markdown = `This is some [Markdown](https://daringfireball.net/projects/markdown/)! Links are extracted to the end of the paragraph.
Here's a second paragraph! Things like **bold** and _italic_ are ignored unless options are set.`;

const gemtext = md2gemini(markdown);
console.log(gemtext);
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "radare2-book",
"version": "1.0.0",
"type":"module",
"version": "1.0.1",
"description": "the official radare2 book",
"scripts": {
"build": "gitbook build . _r2book",
Expand All @@ -18,6 +19,7 @@
},
"homepage": "https://github.com/radareorg/radare2-book#readme",
"dependencies": {
"gemdown": "^0.6.0",
"gitbook-cli": "^2.3.2"
}
}
9 changes: 5 additions & 4 deletions src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ updated by many contributors over the Internet.

Check the Github site to add new contents or fix typos:

* Github: [https://github.com/radareorg/radare2-book](https://github.com/radareorg/radare2-book)
* PDF: [GHA Artifacts](https://github.com/radareorg/radare2-book/releases)
* EPUB: [GHA Artifacts](https://github.com/radareorg/radare2-book/releases)
* Online: [https://book.rada.re/](https://book.rada.re/)
* [GitHub](https://github.com/radareorg/radare2-book)
* [PDF](https://github.com/radareorg/radare2-book/releases)
* [EPUB](https://github.com/radareorg/radare2-book/releases)
* [Read it Online](https://book.rada.re/)
* [Read it on Gemini](gemini://radare.org/book)
38 changes: 28 additions & 10 deletions src/first_steps/compilation_portability.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,41 +8,59 @@ Compared to core, the debugger feature is more restrictive portability-wise. If

Note that there are I/O plugins that use GDB, WinDbg, or Wine as back-ends, and therefore rely on presence of corresponding third-party tools (in case of remote debugging - just on the target machine).

To build on a system using `acr` and `GNU Make` (e.g. on *BSD systems):
```
To build on a system using `acr` and `GNU Make` (e.g. on *BSD systems*):

```sh
$ ./configure --prefix=/usr
$ gmake
$ sudo gmake install
```

There is also a simple script to do this automatically:
```

```sh
$ sys/install.sh
```

### Static Build

You can build radare2 statically along with all other tools with the command:
```

```sh
$ sys/static.sh
```

### Meson build

You can use meson + ninja to build:
You can use meson/ninja to build (or muon/samu):

```sh
$ meson b && ninja -C b
```

There's a helper script in sys/ to make the meson experience a little bit simpler:

```sh
$ sys/meson.py --prefix=/usr --shared --install
```

If you want to build locally:
```

```sh
$ sys/meson.py --prefix=/home/$USER/r2meson --local --shared --install
```

### Docker

Radare2 repository ships a [Dockerfile](https://github.com/radareorg/radare2/blob/master/Dockerfile) that you can use with Docker.
Radare2 repository ships a [Dockerfile](https://github.com/radareorg/radare2/blob/master/dist/docker/Dockerfile) that you can use with Docker.

This dockerfile also used by Remnux distribution from SANS, and is available on the docker [registryhub](https://registry.hub.docker.com/u/remnux/radare2/).

This dockerfile is also used by Remnux distribution from SANS, and is available on the docker [registryhub](https://registry.hub.docker.com/u/remnux/radare2/).
Checkout the Makefile in this directory to understand how to use it without too much hussle

## Cleaning Up Old Radare2 Installations
```

```sh
./configure --prefix=/old/r2/prefix/installation
make purge
```

5 changes: 3 additions & 2 deletions src/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@ updated by many contributors over the Internet.

Check the Github site to add new contents or fix typos:

* Github: [https://github.com/radareorg/radare2-book](https://github.com/radareorg/radare2-book)
* Online: [https://book.rada.re/](https://book.rada.re/)
* [Github repository](https://github.com/radareorg/radare2-book)
* [Read it online](https://book.rada.re/)
* [Read it on Gemini](gemini://radare.org/book/)

0 comments on commit bffd395

Please sign in to comment.