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
Copy file name to clipboardExpand all lines: README.md
+9-4Lines changed: 9 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,6 +15,11 @@ This tool roughly approximates the functionality of the AtomVM `PackBEAM` utilit
15
15
16
16
The `packbeam` tool may be used on its own as a stand-alone command-line utility. More typically, it is used internally as part of the [`atomvm_rebar3_plugin`](https://github.com/atomvm/atomvm_rebar3_plugin)[`rebar3`](https://rebar3.org) plugin.
17
17
18
+
[Releases](https://hex.pm/packages/atomvm_packbeam) and
19
+
[accompanying documentation](https://hexdocs.pm/atomvm_packbeam/readme.html) are available on
20
+
[hex.pm](https://hex.pm). The documentation for the current master branch is always available from
21
+
the [`atomvm_packbeam` GitHub pages](https://atomvm.github.io/atomvm_packbeam/readme.html).
22
+
18
23
## Prerequisites
19
24
20
25
Building `packbeam` requires a version of Erlang/OTP compatible with [AtomVM](https://github.com/atomvm/AtomVM), as well as a local installation of [`rebar3`](https://rebar3.org). Optionally, any recent version of `make` may be used to simplify builds. Consult the [AtomVM Documentation](https://doc.atomvm.org/latest/) for information about supported OTP versions.
@@ -29,16 +34,16 @@ To build a release, run the following commands:
29
34
These commands will create an Erlang tar archive containing a versioned release of the `atomvm_packbeam` tool, e.g.,
> IMPORTANT! The files in this tar archive do not contain the `atomvm_packbeam` prefix, so extracting these files without care will create a `bin` and `lib` directory in the location into which files from the archive is extracted. See the example below before proceeding!
37
42
38
43
You can use the `install.sh` script to install the `atomvm_packbeam` utility into a location on your local machine. You will need to specify the prefix location into which you want to install the utility, together with it's current version.
39
44
40
-
shell$ ./install.sh /opt/atomvm_packbeam 0.7.4
41
-
atomvm_packbeam version 0.7.4 installed in /opt/atomvm_packbeam.
45
+
shell$ ./install.sh /opt/atomvm_packbeam 0.7.5
46
+
atomvm_packbeam version 0.7.5 installed in /opt/atomvm_packbeam.
42
47
43
48
> Note. Some prefix locations may require `root` permissions to write files to.
44
49
@@ -64,7 +69,7 @@ On-line help is available via the `help` sub-command:
0 commit comments