diff --git a/README.rst b/README.rst index 4d78564..b756b24 100644 --- a/README.rst +++ b/README.rst @@ -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 `_. +in `this document `_. If you need YOGA as a library or if you really want to build it yourself, look in the `winbuild `_ diff --git a/doc/_static/logo.png b/doc/_static/logo.png new file mode 100644 index 0000000..0650969 Binary files /dev/null and b/doc/_static/logo.png differ diff --git a/doc/cli/image.rst b/doc/cli/image.rst new file mode 100644 index 0000000..8f1b796 --- /dev/null +++ b/doc/cli/image.rst @@ -0,0 +1,4 @@ +YOGA Image Command Line Interface +================================= + +TODO diff --git a/doc/cli/index.rst b/doc/cli/index.rst new file mode 100644 index 0000000..431069a --- /dev/null +++ b/doc/cli/index.rst @@ -0,0 +1,11 @@ +Command Line Interface +====================== + +TODO + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + ./image.rst + ./model.rst diff --git a/doc/cli/model.rst b/doc/cli/model.rst new file mode 100644 index 0000000..48896ab --- /dev/null +++ b/doc/cli/model.rst @@ -0,0 +1,4 @@ +YOGA Model Command Line Interface +================================= + +TODO diff --git a/doc/index.rst b/doc/index.rst index d9ba9ca..1a32e3e 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -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` diff --git a/doc/install.rst b/doc/install.rst new file mode 100644 index 0000000..f9a85aa --- /dev/null +++ b/doc/install.rst @@ -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 + `_. + + +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 +`_ +folder. diff --git a/doc/python/index.rst b/doc/python/index.rst new file mode 100644 index 0000000..2ffb500 --- /dev/null +++ b/doc/python/index.rst @@ -0,0 +1,4 @@ +Python API +========== + +TODO