Skip to content

Commit 699bda9

Browse files
author
RogueMacro
committed
Update readme for v0.1.0
1 parent 5592588 commit 699bda9

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

README.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,33 +6,31 @@ Browse packages and manage your own at https://grillpm.vercel.app/
66

77
# Getting started
88

9-
Download the latest release of the CLI from either [GitHub Releases](https://github.com/RogueMacro/grill/releases/latest) or [Chocolatey](https://community.chocolatey.org/packages/grill/0.1.0).
9+
Download the latest release of the CLI from [GitHub Releases](https://github.com/RogueMacro/grill/releases/latest).
1010

11-
Add a `Package.toml` manifest file in the root directory of your project.
12-
Here is an example manifest:
11+
Run `grill new MyProject` or `grill init` for existing Beef Workspaces. After creating a project you can add dependencies and run `grill make` to build your workspace. Here is an example manifest:
1312

1413
```toml
1514
[Package]
16-
Name = "Foo"
15+
Name = "MyGui"
1716
Version = "0.1.0"
17+
Description = "A small GUI application"
1818

1919
[Dependencies]
20-
Bar = "1.3.2"
20+
OpenGL = "3.3"
2121
```
2222

23-
After adding `Package.toml`, run `grill make` to build a workspace.
24-
25-
**Note:** Any projects added manually to a workspace will be removed when running `grill make`, unless they are specified in `Package.toml`. Git URLs, BeefLibs and relative dependencies are not supported yet.
26-
27-
# Installing a package to BeefLibs
28-
29-
You can install packages (or repositories) into the `BeefLibs` folder by using `grill install <package>` or `grill install --git <url>`. The library can then be added to workspaces in the IDE.
30-
31-
**Note:** BeefLibs are not supported in packages (running `grill make` will remove those libraries from the workspace).
23+
**Note:** The workspace file is generated automatically by Grill. Changes to it will be reverted when building the workspace. Fields specified in project files will be preserved.
3224

3325
# Publishing packages
3426

3527
To publish packages, you need to get your API token on the website at Account > Settings > Authorization.
3628
Run `grill login` and paste your token there.
3729

3830
After logging in through the CLI, make sure you commit and push your changes, then run `grill publish` and confirm the version and commit. It will not succeed if the commit isn't found remotely.
31+
32+
# Installing a package to BeefLibs
33+
34+
You can install packages (or repositories) into the `BeefLibs` folder by using `grill install <package>` or `grill install --git <url>`. The library can then be added to workspaces in the IDE.
35+
36+
**Note:** BeefLibs are not supported in packages (running `grill make` will remove those libraries from the workspace).

0 commit comments

Comments
 (0)