pesde-pkg/pesde
1
1
Fork 0
mirror of https://github.com/pesde-pkg/pesde.git synced 2024-12-12 11:00:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

docs: document making bin packages

Browse source
This commit is contained in:
daimond113 2024-11-21 17:03:20 +01:00
parent 85312525f1
commit e9bb21835c
No known key found for this signature in database
GPG key ID: 3A8ECE51328B513C
1 changed files with 35 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
docs/src/content/docs/guides/binary-packages.mdx
View file

@ -8,9 +8,9 @@ A **binary package** is a package that contains a binary export.
Binary packages can be run like a normal program. There are several ways to use Binary packages can be run like a normal program. There are several ways to use
binary packages with pesde. binary packages with pesde.
To make your own binary package, see the [guide](/quickstart#adding-a-main-script). ## Using a binary package
## Using `pesde x` ### With `pesde x`
The `pesde x` command can be used to run a one-off binary package. This is The `pesde x` command can be used to run a one-off binary package. This is
useful for running a binary package without installing it or outside of a pesde useful for running a binary package without installing it or outside of a pesde
@ -21,7 +21,7 @@ pesde x pesde/hello
# Hello, pesde! (pesde/hello@1.0.0, lune) # Hello, pesde! (pesde/hello@1.0.0, lune)
``` ```
## Installing a binary package ### By installing
Binary packages can be installed using the `pesde add` and `pesde install` Binary packages can be installed using the `pesde add` and `pesde install`
commands. commands.
@ -35,9 +35,40 @@ pesde install
``` ```
This will add the binary package to your `PATH`, meaning that it can be run This will add the binary package to your `PATH`, meaning that it can be run
anywhere! anywhere in a project which has it installed under that alias!
```sh ```sh
hello hello
# Hello, pesde! (pesde/hello@1.0.0, lune) # Hello, pesde! (pesde/hello@1.0.0, lune)
``` ```
## Making a binary package
To make a binary package you must use a target compatible with binary exports.
These currently are `lune` and `luau`.
Here is an example of a binary package:
```toml title="pesde.toml"
name = "pesde/hello"
version = "1.0.0"
license = "MIT"
[target]
environment = "lune"
bin = "main.luau"
```
The `bin` field specifies the entry point for the binary package. This file
will be run when the binary package is executed.
```luau title="main.luau"
print("Hello, pesde!")
```
Binary packages get access to custom variables provided by pesde. You can find
them in the `_G` table. These are:
- `PESDE_ROOT`: The root (where the pesde.toml is located) of where the package is
installed. This will be in a temporary directory if the package is run with
`pesde x`.