mirror of https://github.com/wanadev/yoga.git
Index and Install pages (+fixes)
This commit is contained in:
parent
6886412efd
commit
827d6890fa
|
@ -74,13 +74,13 @@ Build and install using the following command::
|
|||
Windows
|
||||
~~~~~~~
|
||||
|
||||
The simplest way to use YOGA on Windows is to download the lastest standalone build here:
|
||||
The simplest way to use YOGA on Windows is to download the latest standalone build here:
|
||||
|
||||
* https://github.com/wanadev/yoga/releases
|
||||
|
||||
You will have to install Microsoft Visual C++ Redistribuable for Visual Studio
|
||||
2019 to run YOGA. You will find more information in the Zip you downloaded or
|
||||
on in `this document <https://github.com/wanadev/yoga/blob/master/winbuild/README-windows-dist.md>`_.
|
||||
in `this document <https://github.com/wanadev/yoga/blob/master/winbuild/README-windows-dist.md>`_.
|
||||
|
||||
If you need YOGA as a library or if you really want to build it yourself, look
|
||||
in the `winbuild <https://github.com/wanadev/yoga/tree/master/winbuild>`_
|
||||
|
|
Binary file not shown.
After Width: | Height: | Size: 23 KiB |
|
@ -0,0 +1,4 @@
|
|||
YOGA Image Command Line Interface
|
||||
=================================
|
||||
|
||||
TODO
|
|
@ -0,0 +1,11 @@
|
|||
Command Line Interface
|
||||
======================
|
||||
|
||||
TODO
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
./image.rst
|
||||
./model.rst
|
|
@ -0,0 +1,4 @@
|
|||
YOGA Model Command Line Interface
|
||||
=================================
|
||||
|
||||
TODO
|
|
@ -1,15 +1,34 @@
|
|||
.. YOGA documentation master file, created by
|
||||
sphinx-quickstart on Mon Jan 18 15:21:22 2021.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to YOGA's documentation!
|
||||
================================
|
||||
|
||||
.. figure:: https://github.com/wanadev/yoga/raw/master/logo.png
|
||||
:alt:
|
||||
|
||||
**YOGA** is a command-line tool and a library that can:
|
||||
|
||||
* convert and optimize images from various format to JPEG and PNG,
|
||||
* convert and optimize 3D models from various formats to `GLB`_.
|
||||
|
||||
**Images** are opened using Pillow_ and optimized using Guetzli_ (for JPEGs) and
|
||||
Zopflipng_ (for PNGs).
|
||||
|
||||
**3D Models** are converted and optimized using assimp_. If models contain or
|
||||
reference images, they are processed by YOGA's image optimizer.
|
||||
|
||||
.. _GLB: https://www.khronos.org/gltf/
|
||||
.. _Pillow: https://github.com/python-pillow/Pillow
|
||||
.. _Guetzli: https://github.com/google/guetzli
|
||||
.. _Zopflipng: https://github.com/google/zopfli
|
||||
.. _assimp: https://github.com/assimp/assimp
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
./install.rst
|
||||
./cli/index.rst
|
||||
./python/index.rst
|
||||
|
||||
|
||||
|
||||
Indices and tables
|
||||
|
@ -17,4 +36,3 @@ Indices and tables
|
|||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
|
|
@ -0,0 +1,62 @@
|
|||
Installing YOGA
|
||||
===============
|
||||
|
||||
Linux (Sources)
|
||||
---------------
|
||||
|
||||
To install YOGA from sources, you will have to install some build dependencies first.
|
||||
|
||||
On Debian / Ubuntu, you can install everything you need using the following command::
|
||||
|
||||
sudo apt install build-essential cmake python3 python3-dev python3-pip python-setuptools
|
||||
|
||||
|
||||
From PyPI
|
||||
~~~~~~~~~
|
||||
|
||||
To install YOGA from PyPI following command (as ``root`` on Linux)::
|
||||
|
||||
pip3 install yoga
|
||||
|
||||
|
||||
From this repository
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Then clone the repository::
|
||||
|
||||
git clone https://github.com/wanadev/yoga.git
|
||||
|
||||
Go to the project's directory::
|
||||
|
||||
cd yoga
|
||||
|
||||
Build and install using the following command::
|
||||
|
||||
python3 setup.py install
|
||||
|
||||
|
||||
Windows
|
||||
-------
|
||||
|
||||
Windows Standalone Releases
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The simplest way to use YOGA on Windows is to download the latest standalone build here:
|
||||
|
||||
* https://github.com/wanadev/yoga/releases
|
||||
|
||||
.. NOTE::
|
||||
|
||||
You will have to install Microsoft Visual C++ Redistribuable for Visual
|
||||
Studio 2019 to run YOGA. You will find more information in the Zip you
|
||||
downloaded or in `this document
|
||||
<https://github.com/wanadev/yoga/blob/master/winbuild/README-windows-dist.md>`_.
|
||||
|
||||
|
||||
Building YOGA on Windows
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
If you need YOGA as a library or if you really want to build it yourself, look
|
||||
in the `winbuild/ folder of the source repository
|
||||
<https://github.com/wanadev/yoga/tree/master/winbuild>`_
|
||||
folder.
|
|
@ -0,0 +1,4 @@
|
|||
Python API
|
||||
==========
|
||||
|
||||
TODO
|
Loading…
Reference in New Issue