Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
keijiro committed Nov 18, 2023
1 parent 73c2ce7 commit dc5305d
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 88 deletions.
49 changes: 5 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,12 @@ KlakSyphon
**KlakSyphon** is a [Syphon] plugin for Unity that allows sharing frames
between applications with minimum CPU/GPU cost.

The most important feature of KlakSyphon is that it supports [Metal]. You can
use Metal on Unity to utilize the GPU features and, at the same time, use Unity
in combinations with other Syphon-enabled OpenGL applications, like [VDMX] or
[MadMapper].

[Syphon]: http://syphon.v002.info
[Metal]: https://developer.apple.com/metal/
[VDMX]: http://vidvox.net
[MadMapper]: https://madmapper.com

System Requirements
-------------------

- Unity 2021.2
- Unity 2022.3
- Metal graphics API
- MacOS 12.1 Monterey

Expand All @@ -28,39 +20,8 @@ KlakSyphon only supports Metal; It doesn't support the OpenGL (GL Core) mode.
How to install
--------------

This package uses the [scoped registry] feature to resolve package dependencies.
Please add the following sections to the manifest file (Packages/manifest.json).

[scoped registry]: https://docs.unity3d.com/Manual/upm-scoped.html

To the `scopedRegistries` section:

```
{
"name": "Keijiro",
"url": "https://registry.npmjs.com",
"scopes": [ "jp.keijiro" ]
}
```

To the `dependencies` section:

```
"jp.keijiro.klak.syphon": "0.0.4"
```

After changes, the manifest file should look like below:
[Follow those instructions] to set up the scoped registry. Then, you can install
the Duotone package via Package Manager.

```
{
"scopedRegistries": [
{
"name": "Keijiro",
"url": "https://registry.npmjs.com",
"scopes": [ "jp.keijiro" ]
}
],
"dependencies": {
"jp.keijiro.klak.syphon": "0.0.4",
...
```
[Follow those instructions]:
https://gist.github.com/keijiro/f8c7e8ff29bfe63d86b888901b82644c
49 changes: 5 additions & 44 deletions jp.keijiro.klak.syphon/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,12 @@ KlakSyphon
**KlakSyphon** is a [Syphon] plugin for Unity that allows sharing frames
between applications with minimum CPU/GPU cost.

The most important feature of KlakSyphon is that it supports [Metal]. You can
use Metal on Unity to utilize the GPU features and, at the same time, use Unity
in combinations with other Syphon-enabled OpenGL applications, like [VDMX] or
[MadMapper].

[Syphon]: http://syphon.v002.info
[Metal]: https://developer.apple.com/metal/
[VDMX]: http://vidvox.net
[MadMapper]: https://madmapper.com

System Requirements
-------------------

- Unity 2021.2
- Unity 2022.3
- Metal graphics API
- MacOS 12.1 Monterey

Expand All @@ -28,39 +20,8 @@ KlakSyphon only supports Metal; It doesn't support the OpenGL (GL Core) mode.
How to install
--------------

This package uses the [scoped registry] feature to resolve package dependencies.
Please add the following sections to the manifest file (Packages/manifest.json).

[scoped registry]: https://docs.unity3d.com/Manual/upm-scoped.html

To the `scopedRegistries` section:

```
{
"name": "Keijiro",
"url": "https://registry.npmjs.com",
"scopes": [ "jp.keijiro" ]
}
```

To the `dependencies` section:

```
"jp.keijiro.klak.syphon": "0.0.4"
```

After changes, the manifest file should look like below:
[Follow those instructions] to set up the scoped registry. Then, you can install
the Duotone package via Package Manager.

```
{
"scopedRegistries": [
{
"name": "Keijiro",
"url": "https://registry.npmjs.com",
"scopes": [ "jp.keijiro" ]
}
],
"dependencies": {
"jp.keijiro.klak.syphon": "0.0.4",
...
```
[Follow those instructions]:
https://gist.github.com/keijiro/f8c7e8ff29bfe63d86b888901b82644c

0 comments on commit dc5305d

Please sign in to comment.