Skip to content

Commit

Permalink
doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
devernay committed May 31, 2018
1 parent 177f692 commit 20995e4
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 6 deletions.
6 changes: 5 additions & 1 deletion .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
Please ask questions ("how do I...?") on the [forum](http://forum.natron.fr), not by filing issues.
Please ask questions ("how do I...?") on the [forum](https://discuss.pixls.us/c/software/natron), not by filing issues.

Please read carefully the [Troubleshooting](http://natron.readthedocs.io/en/rb-2.3/guide/getstarted-troubleshooting.html) section of the [Natron documentation](http://natron.readthedocs.io) before submitting an issue: this issue may already be signaled, or may have a simple workaround.

Make concrete suggestions for fixing the code ("here is a patch") by filing
a [pull request](https://github.com/MrKepzie/Natron/pull/new/master), not an issue.
Expand All @@ -12,6 +14,8 @@ Describe the problem or suggestion here.

**Actual behavior:** [What actually happened]

* If your problem can be reproduced using a Natron project, please include a link to the project on a file sharing service, or attach the project as a zip file to this issue, if possible.

* If your problem is a crash in an official release/snapshot, please include verbose output from the application
from a terminal if possible. If you also submitted a crash report, indicate the CrashID if possible.

Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ We use GitHub's issue tracking system for bugs and enhancements:
https://github.com/NatronGitHub/Natron/issues

**If you are merely asking a question ("how do I...")**, please do not file an
issue, but instead ask the question on the [forum](http://forum.natron.fr).
issue, but instead ask the question on the [forum](https://discuss.pixls.us/c/software/natron).

If you are submitting a bug report, please be sure to note which version of
Natron you are using, and on what platform (OS/version).
Expand Down Expand Up @@ -58,7 +58,7 @@ All code must be formally reviewed before being merged into the official reposit

5. If your patch will induce a major compatibility break, or has a design
component that deserves extended discussion or debate among the wider Natron
community, then it may be prudent to make a post on our [forum](http://forum.natron.fr) pointing everybody to
community, then it may be prudent to make a post on our [forum](https://discuss.pixls.us/c/software/natron) pointing everybody to
the pull request URL and discussing any issues you think are important.

6. The reviewer will look over the code and critique on the "comments" area,
Expand Down
4 changes: 2 additions & 2 deletions Documentation/source/guide/getstarted-troubleshooting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Luckily, there are workarounds for most Natron crashes or hangs. Here are a few

#. Avoid using videos with inter-frame compression as inputs and outputs. This includes H.264 (eg AVCHD) and H.265 (HEVC) video. ProRes is OK but slow, especially for writing. DNxHR is OK. Individual frames are *best* (DPX, EXR, TIFF, PNG, JPEG, whatever suits your input video quality and bit depth). The video reader is here for convenience, but it may have difficulties decoding some videos. The video writer may also be a source of bugs, and should be avoided for long sequences: if Natron crashes in the middle, then the whole sequence has to be rendered. Extract individual frames, do your compositing, then compress the frames (and optionally mux the audio) with an external tool. To extract frames, you may use a simple Natron project or any other tool (e.g. `FFmpeg <https://www.ffmpeg.org/ffmpeg.html>`_). To compress frames to a video, there are also many tools available, e.g. `FFmpeg <https://www.ffmpeg.org/ffmpeg.html>`_, `MEncoder <https://en.wikipedia.org/wiki/MEncoder>`_, or `VirtualDub <http://virtualdub.sourceforge.net/>`_ (windows-only). This is the standard compositing workflow and the preferred method of running Natron.
#. If Natron hangs or crashes when rendering an image sequence (this does not work when rendering to a video), check that the rendered frames are OK, relaunch Natron and in the parameters of the Write node uncheck "Overwrite". That way, only the missing frames will be rendered.
#. If you have a large project, or a project with heavy processing, use the DiskCache :ref:`fr.inria.built-in.DiskCache` node at places that make sense: downstream heavy processing in the graph, or before you use the result of processing as inputs to Roto :ref:`fr.inria.built-in.Roto` or RotoPaint `fr.inria.built-in.RotoPaint`.
#. If you have a large project, or a project with heavy processing, use the :ref:`fr.inria.built-in.DiskCache` at places that make sense: downstream heavy processing in the graph, or before you use the result of processing as inputs to :ref:`fr.inria.built-in.Roto` or :ref:`fr.inria.built-in.RotoPaint`.

You will quickly notice that using individual frames instead of videos for inputs and output give a *big* performance boost and will most probably solve your issues, so once you've learned how to decompress/compress any video, this will become your standard workflow. Just add extra disk space, and you're good to do serious and fluid compositing with Natron.

Expand All @@ -51,7 +51,7 @@ OpenGL/GPU Rendering Issues

If the viewer displays some error message about OpenGL, then GPU rendering is probably going bad. Note that this kind of problem seems to only happen on Windows, so you might want to consider switching to Linux or macOS to use Natron if your GPU is not well supported by Natron under Windows.

#. Create a Shadertoy :ref:`net.sf.openfx.Shadertoy` node, click "Renderer Info..." and check that the OpenGL version is at least 2.1 and that the extension ``GL_ARB_texture_non_power_of_two`` is available. If the displayed info does not correspond to your graphics card, check that the OpenGL drivers for your card are installed. If not, install the software called "OpenGL Extension Viewer" and check that your card appears in the list of renderers. If not, then it is a drivers issue.
#. Create a :ref:`net.sf.openfx.Shadertoy`, click "Renderer Info..." and check that the OpenGL version is at least 2.1 and that the extension ``GL_ARB_texture_non_power_of_two`` is available. If the displayed info does not correspond to your graphics card, check that the OpenGL drivers for your card are installed. If not, install the software called "OpenGL Extension Viewer" and check that your card appears in the list of renderers. If not, then it is a drivers issue.
#. In Natron Preferences / GPU Rendering, check that the displayed is consistent with what "Renderer Info..." above gave.
#. Now uncheck "Enable GPU Render" in the Shadertoy node and click the refresh/recycle button on the top of the viewer. Click again "Renderer Info..." and it should say it now uses Mesa in the ``GL_VERSION``. Does it fix the issue? If yes, you may try the next step to globally disable OpenGL rendering in Natron.
#. To temporarily fix this issue, in Natron Preferences / GPU Rendering, set "OpenGL Rendering" to "Disabled", click the "Save" button in the Preferences window, quit Natron, launch Natron, check that GPU rendering is still disabled in the Preferences, and test your project.
2 changes: 1 addition & 1 deletion Global/Macros.h
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ namespace NATRON_PYTHON_NAMESPACE { }
#define NATRON_ORGANIZATION_DOMAIN NATRON_ORGANIZATION_DOMAIN_SUB "." NATRON_ORGANIZATION_DOMAIN_TOPLEVEL
#define NATRON_APPLICATION_NAME "Natron"
#define NATRON_WEBSITE_URL "http://www.natron.fr"
#define NATRON_FORUM_URL "https://forum.natron.fr"
#define NATRON_FORUM_URL "https://discuss.pixls.us/c/software/natron"
#define NATRON_ISSUE_TRACKER_URL "https://github.com/NatronGitHub/Natron/issues"

// The MIME types for Natron documents are:
Expand Down

0 comments on commit 20995e4

Please sign in to comment.