Skip to content

Commit fa77898

Browse files
committed
README: Shorter intro jumping right to an example
1 parent 7aeb30c commit fa77898

File tree

1 file changed

+28
-8
lines changed

1 file changed

+28
-8
lines changed

README.rst

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,33 @@ design of this version is heavily inspired by the
1414
+-----------------+-----------------+
1515

1616
We only support OpenGL 3.3+ forward compatible core profiles (no backwards compatibility).
17+
Originally made for for non-interactive real time graphics combined with music
18+
("real time music videos"), but can of course be used for other purposes.
1719

18-
This was originally made for for non-interactive real time graphics
19-
combined with music ("real time music videos"), but can of course
20-
be used for other purposes.
21-
22-
It's made for people who enjoy playing around with modern OpenGL without having to spend lots of
20+
Made for people who enjoy playing around with modern OpenGL without spending time
2321
time creating all the tooling to get things up and running.
2422

25-
If you are not a fan of using a framework, you can create your own context
26-
and just use the classes in ``demosys.opengl``. These will give you fairly
27-
straight forward ways to use VAOs, Shaders, Textures and FBOs.
23+
Setting a project with a spinning cube can be done in less than a minute
24+
25+
.. code-block:: shell
26+
27+
pip install demosys-py
28+
demosys-admin createproject myproject
29+
demosys-admin createeffect myproject/cube
30+
31+
Now edit ``myproject/settings.py`` and add the effect to the ``EFFECTS`` tuple.
32+
33+
.. code-block:: python
34+
35+
EFFECTS = (
36+
'myproject.cube',
37+
)
38+
39+
Now run the effect!
40+
41+
.. code-block:: shell
42+
43+
./manage.py runeffect myproject.cube
2844
2945
Documentation
3046
-------------
@@ -51,6 +67,10 @@ Features
5167
- A geometry module for quick creation of common mesh/VAO types
5268
- (Experimental audio playback support)
5369

70+
If you are not a fan of using a framework, you can create your own context
71+
and just use the classes in ``demosys.opengl``. These will give you fairly
72+
straight forward ways to use VAOs, Shaders, Textures and FBOs.
73+
5474
Requirements
5575
------------
5676

0 commit comments

Comments
 (0)