Skip to content

Commit

Permalink
doc: finalize readme for separate packaging of runtime and application
Browse files Browse the repository at this point in the history
  • Loading branch information
maxirmx committed Dec 18, 2024
1 parent ceed09f commit d030430
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
14 changes: 10 additions & 4 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ with patched filesystem calls that redirect access of project files to the
on-file filesystem ("runtime")

Tebako is capable to create a single file that contains both runtime and application or
place runtime and application to separate files. In the latter case the runtime can be used with different
place runtime and application to separate files. In the latter case the runtime can be used with different
applications or versions of the samae applciation.

Please refer to ```mode``` option below that controls tebako output.
Expand Down Expand Up @@ -746,7 +746,8 @@ tebako press \
[-c|--cwd=<package current working directory>]
[-D|--devmode] \
[-P|--patchelf] \
[-m|--mode=<bundle|both|application|runtime>]
[-m|--mode=<bundle|both|application|runtime>] \
[-u|--ref=<runtime-reference>] \
[-t|--tebafile=<path-to-tebafile>]
----

Expand All @@ -770,8 +771,8 @@ packaged file is called. This parameter is not required if the operation mode is
`output`::
the output file name (optional, defaults to `<current folder>/<entry point base name>`
On Windows output file will have `exe` extension.
if application is placed to a separate file (`both` or `application` mode) it will have the
same name with `tebako` extension.
if application is placed to a separate file (`both` or `application` mode) it will have the
same name with `tebako` extension.

`log-level`::
logging level for the Tebako built-in memory filesystem driver
Expand All @@ -798,6 +799,11 @@ both - create both run-rime and application
application - create appplication only
runtime - create runtime only

`ref`::
When tabako application package is created on Windows it is linked against tebako runtime file name.
ref parameter allows to specify the name of the runtime file. Default is 'tebako-runtime'.
Note that it is the name only, runtime file can be recreated or changed but not renamed.

`tebafile`::
the tebako configuration file (optional, defaults to `$PWD/.tebako.yml`).
Please refer to the separate section below for tebafile description.
Expand Down
2 changes: 1 addition & 1 deletion lib/tebako/version.rb
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@
# POSSIBILITY OF SUCH DAMAGE.

module Tebako
VERSION = "0.10.1.rc1"
VERSION = "0.11.0"
end

0 comments on commit d030430

Please sign in to comment.