Skip to content

Commit c46cdae

Browse files
committed
Link to a PowerShell guide from the README.
1 parent 655517f commit c46cdae

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.rst

+3-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ Features of SQ include:
2222
Usage
2323
============================================================
2424

25-
You can install SQ via `pip <https://packaging.python.org/en/latest/tutorials/installing-packages/>`__ from the `Python Package Index (PyPI) <https://pypi.org/project/simalq/>`__ with the command ``pip install simalq``, or from source with ``pip install .``. For the best display, you should use a terminal emulator that supports 24-bit color (I'm a fan of `Konsole <https://konsole.kde.org>`__), but SQ should be able to cope with less color support and use the best approximations available via its dependency `blessed <https://pypi.org/project/blessed/>`__. For improved speed, try PyPy instead of CPython.
25+
You can install SQ via `pip <https://packaging.python.org/en/latest/tutorials/installing-packages/>`__ from the `Python Package Index (PyPI) <https://pypi.org/project/simalq/>`__ with the command ``pip install simalq``, or from source with ``pip install .``. For improved speed, try PyPy instead of CPython.
26+
27+
For the best display, you should use a terminal emulator that supports 24-bit color (I'm a fan of `Konsole <https://konsole.kde.org>`__), but SQ should be able to cope with less color support and use the best approximations available via its dependency `blessed <https://pypi.org/project/blessed/>`__. For Windows, SheepsTooth (an SQ fan) has kindly put together `a little step-by-step guide <https://github.com/hylang/simalq/files/14231807/Simalq.instructions.odt>`__ on getting the game to look nice in PowerShell.
2628

2729
Run SQ with ``python3 -m simalq``, or run the tests with ``pytest``. Use ``python3 -m simalq --help`` for options. A good way to start is Tutorial Quest: ``python3 -m simalq Tutorial_Quest``.
2830

0 commit comments

Comments
 (0)