Skip to content

Commit

Permalink
Documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
darbyjohnston committed May 8, 2020
1 parent 69cfb81 commit 3f980d5
Show file tree
Hide file tree
Showing 10 changed files with 42 additions and 63 deletions.
12 changes: 7 additions & 5 deletions docs/_site/build_linux.html
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,7 @@
</pre>

<p class="subHeader"><a name="PackagingDJV">Packaging DJV</a></p>
<p>Update the download information with the new version in "docs/index.html"
and "docs/djv_install.html".</p>
<p>Update the version number "docs/download.html" and "docs/djv_install.html".</p>
<p>Build the static web site:</p>
<pre>
$ cd docs
Expand Down Expand Up @@ -104,17 +103,20 @@
</pre>
<p>Create an RPM package:</p>
<pre>
$ cmake ../DJV -DCPACK_GENERATOR=RPM -DCPACK_PACKAGING_INSTALL_PREFIX=/usr/local/DJV2
$ cmake ../DJV -DCPACK_GENERATOR=RPM -DCPACK_PACKAGING_INSTALL_PREFIX=/usr/local/DJV2 -DDJV_THIRD_PARTY=TRUE
$ cmake --build .
$ cmake --build . --target package
</pre>
<p>Create a Debian package:</p>
<pre>
$ cmake ../DJV -DCPACK_GENERATOR=DEB -DCPACK_PACKAGING_INSTALL_PREFIX=/usr/local/DJV2
$ cmake ../DJV -DCPACK_GENERATOR=DEB -DCPACK_PACKAGING_INSTALL_PREFIX=/usr/local/DJV2 -DDJV_THIRD_PARTY=TRUE
$ cmake --build .
$ cmake --build . --target package
</pre>
<p>Create a TGZ package:</p>
<pre>
$ cmake ../DJV -DCPACK_GENERATOR=TGZ -DCPACK_PACKAGING_INSTALL_PREFIX=
$ cmake ../DJV -DCPACK_GENERATOR=TGZ -DCPACK_PACKAGING_INSTALL_PREFIX= -DDJV_THIRD_PARTY=TRUE
$ cmake --build .
$ cmake --build . --target package
</pre>
<p>Bump the version number in "CMakeLists.txt", "Doxyfile", and "sonar-project.properties".</p>
Expand Down
2 changes: 2 additions & 0 deletions docs/_site/build_osx.html
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,8 @@
</pre>
<p>Build the package:</p>
<pre>
$ cmake ../DJV -DDJV_THIRD_PARTY=TRUE
$ cmake --build .
$ cmake --build . --target package
</pre>

Expand Down
2 changes: 2 additions & 0 deletions docs/_site/build_windows.html
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,8 @@
</pre>
<p>Build the packages:</p>
<pre>
> cmake ..\DJV -DDJV_THIRD_PARTY=TRUE
> cmake --build .
> cmake --build . --target package
</pre>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/_site/djv_install.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
<p class="header"><a name="LinuxRPM">Linux RPM</a></p>
<p>Installing the RPM package:</p>
<pre>
sudo rpm -i DJV2-2.0.5-1.x86_64.rpm
sudo rpm -i DJV2-2.0.6-1.x86_64.rpm
</pre>
<p>The default installation directory is "/usr/local/DJV2".</p>
<p>Starting the DJV viewer:</p>
Expand All @@ -52,7 +52,7 @@
<p class="header"><a name="LinuxDEB">Linux DEB</a></p>
<p>Installing the Debian package:</p>
<pre>
sudo dpkg -i DJV2_2.0.5_amd64.deb
sudo dpkg -i DJV2_2.0.6_amd64.deb
</pre>
<p>The default installation directory is "/usr/local/DJV2".</p>
<p>Starting the DJV viewer:</p>
Expand Down
14 changes: 7 additions & 7 deletions docs/_site/download.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,18 @@
</div>

<div class="block">
<p class="header">Version 2.0.5</p>
<p class="header">Version 2.0.6</p>
<p>Linux:
<a class="text" href="https://sourceforge.net/projects/djv/files/djv-beta/2.0.5/DJV2-2.0.5-1.x86_64.rpm/download">RPM</a>,
<a class="text" href="https://sourceforge.net/projects/djv/files/djv-beta/2.0.5/DJV2_2.0.5_amd64.deb/download">DEB</a>,
<a class="text" href="https://sourceforge.net/projects/djv/files/djv-beta/2.0.5/DJV-2.0.5-Linux.tar.gz/download">TAR.GZ</a>
<a class="text" href="https://sourceforge.net/projects/djv/files/djv-beta/2.0.6/DJV2-2.0.6-1.x86_64.rpm/download">RPM</a>,
<a class="text" href="https://sourceforge.net/projects/djv/files/djv-beta/2.0.6/DJV2_2.0.6_amd64.deb/download">DEB</a>,
<a class="text" href="https://sourceforge.net/projects/djv/files/djv-beta/2.0.6/DJV-2.0.6-Linux.tar.gz/download">TAR.GZ</a>
</p>
<p>Apple macOS:
<a class="text" href="https://sourceforge.net/projects/djv/files/djv-beta/2.0.5/DJV-2.0.5-Darwin.dmg/download">DMG</a>
<a class="text" href="https://sourceforge.net/projects/djv/files/djv-beta/2.0.6/DJV-2.0.6-Darwin.dmg/download">DMG</a>
</p>
<p>Microsoft Windows:
<a class="text" href="https://sourceforge.net/projects/djv/files/djv-beta/2.0.5/DJV-2.0.5-win64.exe/download">EXE</a>,
<a class="text" href="https://sourceforge.net/projects/djv/files/djv-beta/2.0.5/DJV-2.0.5-win64.zip/download">ZIP</a>
<a class="text" href="https://sourceforge.net/projects/djv/files/djv-beta/2.0.6/DJV-2.0.6-win64.exe/download">EXE</a>,
<a class="text" href="https://sourceforge.net/projects/djv/files/djv-beta/2.0.6/DJV-2.0.6-win64.zip/download">ZIP</a>
</p>
<p>The list of changes can be found
<a class="text" href="https://github.com/darbyjohnston/DJV/milestone/1?closed=1">here</a>.
Expand Down
25 changes: 6 additions & 19 deletions docs/_site/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,40 +25,27 @@
</ul>
</div>
<div class="block">
<p><b class="emphasis">2019/11/16 - Version
<a class="text" href="https://github.com/darbyjohnston/DJV/milestone/1?closed=1">2.0.5</a>
released!</b> This version fixes a bug with the Windows package.</p>
<p><b class="emphasis">2019/11/15 - Version
<a class="text" href="https://github.com/darbyjohnston/DJV/milestone/1?closed=1">2.0.4</a>
released!</b> Includes a new color picker, new color management interface, and multi-threaded
performance improvements.</p>
<p><b class="emphasis">2020/05/07 - Version
<a class="text" href="https://github.com/darbyjohnston/DJV/milestone/3">2.0.6</a>
released!</b> This version features over 50 GitHub issues fixed, improved French and
German translations, and expanded CI testing. Thanks to new contributors: CansecoGPC,
Jean-Francois Panisset, Haryo Sukmawanto, Damien Picard, and Stefan Ihringer. Also
thanks to everyone who reported issues on GitHub!</p>
</div>

<div class="separator"></div>

<div class="block">
<p class="indexHeader">Color Picker</p>
<div class="indexVideo">
<iframe class="indexVideo" src="https://player.vimeo.com/video/373489216?loop=1&byline=0&portrait=0" frameborder="0" allow="autoplay; fullscreen" allowfullscreen></iframe>
</div>
</div>

<div class="separator"></div>

<div class="block">
<p class="indexHeader">Color Management Interface</p>
<div class="indexVideo">
<iframe class="indexVideo" src="https://player.vimeo.com/video/373490165?loop=1&byline=0&portrait=0" frameborder="0" allow="autoplay; fullscreen" allowfullscreen></iframe>
</div>
</div>
<div class="block">
<p class="indexText">Color management provided by <a class="text" href="https://opencolorio.org">OpenColorIO</a></p>
</div>

<div class="separator"></div>

<div class="block">
<p class="indexHeader">Multi-Threading</p>
<div class="indexVideo">
<iframe class="indexVideo" src="https://player.vimeo.com/video/373490470?loop=1&byline=0&portrait=0" frameborder="0" allow="autoplay; fullscreen" allowfullscreen></iframe>
</div>
Expand Down
3 changes: 1 addition & 2 deletions docs/build_linux.html
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,7 @@
</pre>

<p class="subHeader"><a name="PackagingDJV">Packaging DJV</a></p>
<p>Update the download information with the new version in "docs/index.html"
and "docs/djv_install.html".</p>
<p>Update the version number "docs/download.html" and "docs/djv_install.html".</p>
<p>Build the static web site:</p>
<pre>
$ cd docs
Expand Down
4 changes: 2 additions & 2 deletions docs/djv_install.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<p class="header"><a name="LinuxRPM">Linux RPM</a></p>
<p>Installing the RPM package:</p>
<pre>
sudo rpm -i DJV2-2.0.5-1.x86_64.rpm
sudo rpm -i DJV2-2.0.6-1.x86_64.rpm
</pre>
<p>The default installation directory is "/usr/local/DJV2".</p>
<p>Starting the DJV viewer:</p>
Expand All @@ -46,7 +46,7 @@
<p class="header"><a name="LinuxDEB">Linux DEB</a></p>
<p>Installing the Debian package:</p>
<pre>
sudo dpkg -i DJV2_2.0.5_amd64.deb
sudo dpkg -i DJV2_2.0.6_amd64.deb
</pre>
<p>The default installation directory is "/usr/local/DJV2".</p>
<p>Starting the DJV viewer:</p>
Expand Down
14 changes: 7 additions & 7 deletions docs/download.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,18 @@
</div>

<div class="block">
<p class="header">Version 2.0.5</p>
<p class="header">Version 2.0.6</p>
<p>Linux:
<a class="text" href="https://sourceforge.net/projects/djv/files/djv-beta/2.0.5/DJV2-2.0.5-1.x86_64.rpm/download">RPM</a>,
<a class="text" href="https://sourceforge.net/projects/djv/files/djv-beta/2.0.5/DJV2_2.0.5_amd64.deb/download">DEB</a>,
<a class="text" href="https://sourceforge.net/projects/djv/files/djv-beta/2.0.5/DJV-2.0.5-Linux.tar.gz/download">TAR.GZ</a>
<a class="text" href="https://sourceforge.net/projects/djv/files/djv-beta/2.0.6/DJV2-2.0.6-1.x86_64.rpm/download">RPM</a>,
<a class="text" href="https://sourceforge.net/projects/djv/files/djv-beta/2.0.6/DJV2_2.0.6_amd64.deb/download">DEB</a>,
<a class="text" href="https://sourceforge.net/projects/djv/files/djv-beta/2.0.6/DJV-2.0.6-Linux.tar.gz/download">TAR.GZ</a>
</p>
<p>Apple macOS:
<a class="text" href="https://sourceforge.net/projects/djv/files/djv-beta/2.0.5/DJV-2.0.5-Darwin.dmg/download">DMG</a>
<a class="text" href="https://sourceforge.net/projects/djv/files/djv-beta/2.0.6/DJV-2.0.6-Darwin.dmg/download">DMG</a>
</p>
<p>Microsoft Windows:
<a class="text" href="https://sourceforge.net/projects/djv/files/djv-beta/2.0.5/DJV-2.0.5-win64.exe/download">EXE</a>,
<a class="text" href="https://sourceforge.net/projects/djv/files/djv-beta/2.0.5/DJV-2.0.5-win64.zip/download">ZIP</a>
<a class="text" href="https://sourceforge.net/projects/djv/files/djv-beta/2.0.6/DJV-2.0.6-win64.exe/download">EXE</a>,
<a class="text" href="https://sourceforge.net/projects/djv/files/djv-beta/2.0.6/DJV-2.0.6-win64.zip/download">ZIP</a>
</p>
<p>The list of changes can be found
<a class="text" href="https://github.com/darbyjohnston/DJV/milestone/1?closed=1">here</a>.
Expand Down
25 changes: 6 additions & 19 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,40 +19,27 @@
</ul>
</div>
<div class="block">
<p><b class="emphasis">2019/11/16 - Version
<a class="text" href="https://github.com/darbyjohnston/DJV/milestone/1?closed=1">2.0.5</a>
released!</b> This version fixes a bug with the Windows package.</p>
<p><b class="emphasis">2019/11/15 - Version
<a class="text" href="https://github.com/darbyjohnston/DJV/milestone/1?closed=1">2.0.4</a>
released!</b> Includes a new color picker, new color management interface, and multi-threaded
performance improvements.</p>
<p><b class="emphasis">2020/05/07 - Version
<a class="text" href="https://github.com/darbyjohnston/DJV/milestone/3">2.0.6</a>
released!</b> This version features over 50 GitHub issues fixed, improved French and
German translations, and expanded CI testing. Thanks to new contributors: CansecoGPC,
Jean-Francois Panisset, Haryo Sukmawanto, Damien Picard, and Stefan Ihringer. Also
thanks to everyone who reported issues on GitHub!</p>
</div>

<div class="separator"></div>

<div class="block">
<p class="indexHeader">Color Picker</p>
<div class="indexVideo">
<iframe class="indexVideo" src="https://player.vimeo.com/video/373489216?loop=1&byline=0&portrait=0" frameborder="0" allow="autoplay; fullscreen" allowfullscreen></iframe>
</div>
</div>

<div class="separator"></div>

<div class="block">
<p class="indexHeader">Color Management Interface</p>
<div class="indexVideo">
<iframe class="indexVideo" src="https://player.vimeo.com/video/373490165?loop=1&byline=0&portrait=0" frameborder="0" allow="autoplay; fullscreen" allowfullscreen></iframe>
</div>
</div>
<div class="block">
<p class="indexText">Color management provided by <a class="text" href="https://opencolorio.org">OpenColorIO</a></p>
</div>

<div class="separator"></div>

<div class="block">
<p class="indexHeader">Multi-Threading</p>
<div class="indexVideo">
<iframe class="indexVideo" src="https://player.vimeo.com/video/373490470?loop=1&byline=0&portrait=0" frameborder="0" allow="autoplay; fullscreen" allowfullscreen></iframe>
</div>
Expand Down

0 comments on commit 3f980d5

Please sign in to comment.