mirror of
https://github.com/pesde-pkg/pesde.git
synced 2025-04-13 07:10:56 +01:00
Compare commits
3 commits
v0.5.3+reg
...
0.5
Author | SHA1 | Date | |
---|---|---|---|
|
32906400ec | ||
|
5c2f831c26 | ||
|
97d9251f69 |
4 changed files with 26 additions and 19 deletions
docs/src/content/docs
|
@ -38,17 +38,17 @@ Git dependencies are dependencies on packages hosted on a Git repository.
|
||||||
|
|
||||||
```toml title="pesde.toml"
|
```toml title="pesde.toml"
|
||||||
[dependencies]
|
[dependencies]
|
||||||
acme = { repo = "acme/package", rev = "main" }
|
acme = { repo = "acme/package", rev = "aeff6" }
|
||||||
```
|
```
|
||||||
|
|
||||||
In this example, we're specifying a dependency on the package contained within
|
In this example, we're specifying a dependency on the package contained within
|
||||||
the `acme/package` GitHub repository at the `main` branch.
|
the `acme/package` GitHub repository at the `aeff6` commit.
|
||||||
|
|
||||||
You can also use a URL to specify the Git repository and a specific commit.
|
You can also use a URL to specify the Git repository and a tag for the revision.
|
||||||
|
|
||||||
```toml title="pesde.toml"
|
```toml title="pesde.toml"
|
||||||
[dependencies]
|
[dependencies]
|
||||||
acme = { repo = "https://git.acme.local/package.git", rev = "aeff6" }
|
acme = { repo = "https://git.acme.local/package.git", rev = "v0.1.0" }
|
||||||
```
|
```
|
||||||
|
|
||||||
You can also specify a path if the package is not at the root of the repository.
|
You can also specify a path if the package is not at the root of the repository.
|
||||||
|
|
|
@ -20,15 +20,15 @@ to get it added.
|
||||||
Studio.
|
Studio.
|
||||||
|
|
||||||
Running `pesde init` will prompt you to select a target, select
|
Running `pesde init` will prompt you to select a target, select
|
||||||
`roblox` or `roblox_server` in this case. This will setup the configuration
|
`roblox` or `roblox_server` in this case. You will be prompted to pick out a
|
||||||
needed to use pesde in a project using Rojo.
|
scripts package. Select `pesde/scripts_rojo` to get started with Rojo.
|
||||||
|
|
||||||
## Usage with other tools
|
## Usage with other tools
|
||||||
|
|
||||||
If you are using a different sync tool, you should look for it's scripts in the
|
If you are using a different sync tool, you should look for it's scripts
|
||||||
pesde-scripts repository. If you cannot find them, you can write your own and
|
package on the registry. If you cannot find it, you can write your own and
|
||||||
optionally submit a PR to help others using the same tool as you get started
|
optionally submit a PR to pesde-scripts to help others using the same tool as
|
||||||
quicker.
|
you get started quicker.
|
||||||
|
|
||||||
Scaffold your project with `pesde init`, select the `roblox` or `roblox_server`
|
Scaffold your project with `pesde init`, select the `roblox` or `roblox_server`
|
||||||
target, and then create a `.pesde/roblox_sync_config_generator.luau` script
|
target, and then create a `.pesde/roblox_sync_config_generator.luau` script
|
||||||
|
|
|
@ -41,6 +41,16 @@ You can follow the installation instructions in the
|
||||||
pesde should now be installed on your system. You may need to restart your
|
pesde should now be installed on your system. You may need to restart your
|
||||||
computer for the changes to take effect.
|
computer for the changes to take effect.
|
||||||
|
|
||||||
|
<Aside type="caution">
|
||||||
|
pesde uses symlinks which are an administrator-level operation on Windows.
|
||||||
|
To ensure proper functionality, enable [Developer Mode](https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development).
|
||||||
|
|
||||||
|
|
||||||
|
If you are getting errors such as `Failed to symlink file, a required
|
||||||
|
privilege is not held by the client`, then enabling this setting will fix
|
||||||
|
them.
|
||||||
|
</Aside>
|
||||||
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
<TabItem label="Linux & macOS">
|
<TabItem label="Linux & macOS">
|
||||||
|
|
||||||
|
|
|
@ -159,12 +159,13 @@ when the package is installed in order to generate the necessary configuration.
|
||||||
|
|
||||||
**Allowed in:** `luau`, `lune`
|
**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
|
copied over to the [scripts](#scripts-1) section when initialising a project with
|
||||||
this package.
|
this package as the scripts package.
|
||||||
|
|
||||||
```toml
|
```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]`
|
## `[scripts]`
|
||||||
|
@ -189,10 +190,6 @@ sync tools.
|
||||||
of files specified within the [`target.build_files`](#build_files) of the
|
of files specified within the [`target.build_files`](#build_files) of the
|
||||||
package.
|
package.
|
||||||
|
|
||||||
You can find template scripts inside the
|
|
||||||
[`pesde-scripts` repository](https://github.com/pesde-pkg/scripts)
|
|
||||||
for various sync tools.
|
|
||||||
|
|
||||||
<LinkCard
|
<LinkCard
|
||||||
title="Roblox"
|
title="Roblox"
|
||||||
description="Learn more about using pesde in Roblox projects."
|
description="Learn more about using pesde in Roblox projects."
|
||||||
|
@ -372,14 +369,14 @@ foo = { wally = "acme/foo", version = "1.2.3", index = "acme" }
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[dependencies]
|
[dependencies]
|
||||||
foo = { repo = "acme/packages", rev = "main", path = "foo" }
|
foo = { repo = "acme/packages", rev = "aeff6", path = "foo" }
|
||||||
```
|
```
|
||||||
|
|
||||||
**Git dependencies** contain the following fields:
|
**Git dependencies** contain the following fields:
|
||||||
|
|
||||||
- `repo`: The URL of the Git repository.
|
- `repo`: The URL of the Git repository.
|
||||||
This can either be `<owner>/<name>` for a GitHub repository, or a full URL.
|
This can either be `<owner>/<name>` for a GitHub repository, or a full URL.
|
||||||
- `rev`: The Git revision to install. This can be a branch, tag, or commit hash.
|
- `rev`: The Git revision to install. This can be a tag or commit hash.
|
||||||
- `path`: The path within the repository to install. If not specified, the root
|
- `path`: The path within the repository to install. If not specified, the root
|
||||||
of the repository is used.
|
of the repository is used.
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue