Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Nitemaeric committed Jan 31, 2025
1 parent 6e888f8 commit 59e0cb8
Showing 1 changed file with 36 additions and 16 deletions.
52 changes: 36 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ installations.

## Installation

For now, you can install **drenv** by downloading the binary from this repo's
releases page.
For now, you can install **drenv** by downloading the executable from this
repo's releases page.

Alternatively, you can clone this repo and build the binary yourself.
Alternatively, you can clone this repo and build the executable yourself.

```sh
deno compile --allow-read --allow-write --allow-env --unstable-kv --output=builds/drenv --target=aarch64-apple-darwin main.ts
Expand All @@ -25,7 +25,7 @@ deno compile --allow-read --allow-write --allow-env --unstable-kv --output=build
> Once **drenv** has been installed, you can seamlessly update to the latest
> version by running `drenv upgrade`.
## Usage
## Help

### `drenv help [command]`

Expand All @@ -46,20 +46,31 @@ Commands:
setup Setup your shell profile to use drenv
new <name> Create a new DragonRuby project
register <path> Register a DragonRuby installation
add <recipe> Setup a pre-configured library
global [version] Get or set the global version of DragonRuby
local [version] Get or set the local version of DragonRuby
versions List out all locally installed versions of DragonRuby
upgrade Upgrade the version of drenv
install [tier] Install the latest version of drenv
help [command] display help for command
```

## Managng **drenv**

### `drenv setup`

This command will move the executable to your home directory and show
instructions on how to add it to your `$PATH`.

This allows you to call `drenv` from anywhere in your terminal.

### `drenv upgrade`

This command will download and upgrade your **drenv** installation to the latest
version.

## Managing DragonRuby Versions

### `drenv register <path>`

This command will copy a local DragonRuby installation at the specified path
Expand All @@ -70,7 +81,7 @@ executable.

> [!IMPORTANT]
> You will need to register at least one DragonRuby installation before you can
> use **drenv**.
> use **drenv** to manage DragonRuby projects.
### `drenv global [version]`

Expand All @@ -80,6 +91,18 @@ creating new projects.
If you call `drenv global` without any arguments, it will display the current
global version.

### `drenv versions`

This command will list out all registered versions of DragonRuby.

```
6.4
* 6.3
5.32
```

## Managing DragonRuby Projects

### `drenv new <name>`

This command will create a new DragonRuby project with the specified name.
Expand All @@ -96,19 +119,16 @@ Under the hood, all **drenv** does is copy the contents of the global DragonRuby
installation into the current project directory, excluding the `mygame`
directory.

### `drenv upgrade`
### `drenv add <recipe>`

This command will download and upgrade your **drenv** installation to the latest
version.
This command will run a pre-configured script that sets up a library or tool for
your DragonRuby project.

### `drenv versions`
Available recipes:

This command will list out all registered versions of DragonRuby.
- [foodchain](https://github.com/pvande/foodchain) - Foodchain is a single-file
library to help you document and install your DragonRuby game's dependencies.

```
5.32
6.4
* 6.3
```
---

Tested on MacOS Macbook Pro M1 with DragonRuby 5.32, 6.3, and 6.4.
Tested on a MacOS Macbook Pro M1 with DragonRuby standard 5.32, 6.3, 6.4, and 6.18.

0 comments on commit 59e0cb8

Please sign in to comment.