Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mawen1250 committed Nov 29, 2021
1 parent 76f4bd9 commit 5ef5bf4
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# nnedi3_resample

A VapourSynth script for easy resizing using nnedi3/znedi3/nnedi3cl with center alignment and correct chroma placement.

## Requirements

- [nnedi3](https://github.com/dubhater/vapoursynth-nnedi3) / [znedi3](https://github.com/sekrit-twc/znedi3) / [nnedi3cl](https://github.com/HomeOfVapourSynthEvolution/VapourSynth-NNEDI3CL)
Expand All @@ -8,7 +10,9 @@

## Usage

Put nnedi3_resample.py into `<python folder>\Lib\site-packages`
For Windows users, put nnedi3_resample.py into
- VapourSynth installed for all users: `<python folder>\Lib\site-packages`
- VapourSynth installed for current user: `%AppData%\Python\Python<version>\site-packages`

## Function

Expand All @@ -23,10 +27,10 @@ Double the width and height of a clip.
```python
import vapoursynth as vs
from vapoursynth import core
import nnedi3_resample as nnrs
from nnedi3_resample import nnedi3_resample

clip = XXXSource()
clip = nnrs.nnedi3_resample(clip, clip.width * 2, clip.height * 2, mode='znedi3')
clip = nnedi3_resample(clip, clip.width * 2, clip.height * 2, mode='znedi3')

clip.set_output()
```
Expand All @@ -37,4 +41,4 @@ clip.set_output()
- `znedi3`, it may be faster than nnedi3
- `nnedi3cl`, it can be used with new options `device` (same as the parameter of the plugin with the same name)
2. Chage how to import core because `get_core` is deprecated.
3. Remove `YCOCG` and `COMPAT`, these will be deprecated in API4.
3. Remove `YCOCG` and `COMPAT`, deprecated in VapourSynth API4.

0 comments on commit 5ef5bf4

Please sign in to comment.