Skip to content

docs: installation options and the openupm badge #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: installation options and the openupm badge #64

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Procedural Toolkit 0.2.3
[![openupm](https://img.shields.io/npm/v/com.syomus.proceduraltoolkit?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.syomus.proceduraltoolkit/)

Procedural Toolkit is a procedural generation library for the Unity game engine.

Expand All @@ -16,8 +17,15 @@ Requires **Unity 2019.2** or later. Tested on Windows, WebGL, Android and iOS.

There are several ways to install Procedural Toolkit:

### Package Manager
The best way is to install this library as a [Git package](https://docs.unity3d.com/Manual/upm-git.html) using the Package Manager.
### Install via OpenUPM
The package is available on the [openupm registry](https://openupm.com). It's recommended to install it via [openupm-cli](https://github.com/openupm/openupm-cli).

```
openupm add com.syomus.proceduraltoolkit
```

### Install via Git URL
The alternative way is to install this library as a [Git package](https://docs.unity3d.com/Manual/upm-git.html) using the Package Manager.
First, make sure that you to have Git installed and available in your system's PATH.
After that you need to add the following line to your project's `manifest.json`:
```
Expand Down