mirror of
https://github.com/pesde-pkg/pesde.git
synced 2025-04-02 01:40:54 +01:00
docs: update scripts docs
Some checks failed
Debug / Get build version (push) Has been cancelled
Test & Lint / lint (push) Has been cancelled
Debug / Build for linux-x86_64 (push) Has been cancelled
Debug / Build for macos-aarch64 (push) Has been cancelled
Debug / Build for macos-x86_64 (push) Has been cancelled
Debug / Build for windows-x86_64 (push) Has been cancelled
Some checks failed
Debug / Get build version (push) Has been cancelled
Test & Lint / lint (push) Has been cancelled
Debug / Build for linux-x86_64 (push) Has been cancelled
Debug / Build for macos-aarch64 (push) Has been cancelled
Debug / Build for macos-x86_64 (push) Has been cancelled
Debug / Build for windows-x86_64 (push) Has been cancelled
This commit is contained in:
parent
5c2f831c26
commit
32906400ec
2 changed files with 10 additions and 13 deletions
|
@ -20,15 +20,15 @@ to get it added.
|
|||
Studio.
|
||||
|
||||
Running `pesde init` will prompt you to select a target, select
|
||||
`roblox` or `roblox_server` in this case. This will setup the configuration
|
||||
needed to use pesde in a project using Rojo.
|
||||
`roblox` or `roblox_server` in this case. You will be prompted to pick out a
|
||||
scripts package. Select `pesde/scripts_rojo` to get started with Rojo.
|
||||
|
||||
## Usage with other tools
|
||||
|
||||
If you are using a different sync tool, you should look for it's scripts in the
|
||||
pesde-scripts repository. If you cannot find them, you can write your own and
|
||||
optionally submit a PR to help others using the same tool as you get started
|
||||
quicker.
|
||||
If you are using a different sync tool, you should look for it's scripts
|
||||
package on the registry. If you cannot find it, you can write your own and
|
||||
optionally submit a PR to pesde-scripts to help others using the same tool as
|
||||
you get started quicker.
|
||||
|
||||
Scaffold your project with `pesde init`, select the `roblox` or `roblox_server`
|
||||
target, and then create a `.pesde/roblox_sync_config_generator.luau` script
|
||||
|
|
|
@ -159,12 +159,13 @@ when the package is installed in order to generate the necessary configuration.
|
|||
|
||||
**Allowed in:** `luau`, `lune`
|
||||
|
||||
A list of scripts that will be linked to the project's `.pesde` directory, and
|
||||
A list of scripts that will be linked to the dependant's `.pesde` directory, and
|
||||
copied over to the [scripts](#scripts-1) section when initialising a project with
|
||||
this package.
|
||||
this package as the scripts package.
|
||||
|
||||
```toml
|
||||
scripts = { roblox_sync_config_generator = "scripts/roblox_sync_config_generator.luau" }
|
||||
[target.scripts]
|
||||
roblox_sync_config_generator = "scripts/roblox_sync_config_generator.luau"
|
||||
```
|
||||
|
||||
## `[scripts]`
|
||||
|
@ -189,10 +190,6 @@ sync tools.
|
|||
of files specified within the [`target.build_files`](#build_files) of the
|
||||
package.
|
||||
|
||||
You can find template scripts inside the
|
||||
[`pesde-scripts` repository](https://github.com/pesde-pkg/scripts)
|
||||
for various sync tools.
|
||||
|
||||
<LinkCard
|
||||
title="Roblox"
|
||||
description="Learn more about using pesde in Roblox projects."
|
||||
|
|
Loading…
Add table
Reference in a new issue