Skip to content

Commit

Permalink
Updated .rst documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
FLAK-ZOSO committed Feb 16, 2024
1 parent 489fedb commit a45a2c1
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 0 deletions.
Binary file added demo/colors256
Binary file not shown.
15 changes: 15 additions & 0 deletions docs/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,21 @@ Since now we'll never going to re-print the ``Field`` object, we'll edit only th

After applying all the movements, we'll swap the characters in the ``stdout`` stream, and then we'll flush the ``stdout`` stream.

``Compilation``
--------------------

To compile the ``sista.cpp`` file, you need to use the following command...

.. code-block:: bash
g++ -std=c++17 -Wall -g -c $(IMPLEMENTATIONS)
g++ -std=c++17 -Wall -g -c sista.cpp
g++ -std=c++17 -Wall -g -o sista sista.o ANSI-Settings.o border.o coordinates.o cursor.o pawn.o field.o
rm -f *.o
...where ``$(IMPLEMENTATIONS)`` is the list of the ``Sista`` library implementation files.


``Notes``
====================

Expand Down
15 changes: 15 additions & 0 deletions docs/sista.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,21 @@
- ``pawn.hpp``: Pawn
- ``sista.hpp``: main header file, includes all the others

Since `v1.1.0` the library is divided in headers and implementation files.
This fact isn't relevant in terms of importation, but it is in terms of compilation.

.. code-block:: bash
# Makefile for sista.cpp
IMPLEMENTATIONS = include/sista/ANSI-Settings.cpp include/sista/border.cpp include/sista/coordinates.cpp include/sista/cursor.cpp include/sista/field.cpp include/sista/pawn.cpp
all:
g++ -std=c++17 -Wall -g -c $(IMPLEMENTATIONS)
g++ -std=c++17 -Wall -g -c sista.cpp
g++ -std=c++17 -Wall -g -o sista sista.o ANSI-Settings.o border.o coordinates.o cursor.o pawn.o field.o
rm -f *.o
``ANSI-Settings.hpp``
================

Expand Down

0 comments on commit a45a2c1

Please sign in to comment.