Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@joshday
joshday committed Feb 9, 2024
1 parent 39727d6 commit bce3228
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@
## Usage

```julia
using DepotDelivery: build_depot
using DepotDelivery: build

path = build_depot("Project.toml"; platform = Base.BinaryPlatforms.HostPlatform())
path = build(path_to_project; platform = Base.BinaryPlatforms.HostPlatform())
```

- `path` is the ready-to-ship depot.
- Your project lives at `path/dev/MyProject`.
- The build settings live in `path/config/depot_build.toml`
- Run this in the airgapped environment to get started: `include("$path/config/depot_startup.jl")`.
- Your project lives at `$path/dev/MyProject`.
- The build settings live in `$path/config/depot_build.toml`
- Run this in the production environment to get started: `include("$path/config/depot_startup.jl")`.

## Building for Non-Host Platforms

Expand Down

2 comments on commit bce3228

@joshday
Copy link
Member Author

@joshday joshday commented on bce3228 Feb 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request updated: JuliaRegistries/General/100508

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.0 -m "<description of version>" bce3228b4cb2d5cffaea0dd14d621677cfb76a9f
git push origin v0.1.0

Please sign in to comment.