Skip to content

Commit 3aa3618

Browse files
committed
Remove extraneous content and rephrase existing SBC sections
* Remove computer lab sections due to being out of scope for the moment * Rephrase heading * Rephrase SBC and other educator content
1 parent 0ac97e5 commit 3aa3618

1 file changed

Lines changed: 86 additions & 88 deletions

File tree

doc/about/for_academia.rst

Lines changed: 86 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -1,147 +1,145 @@
11
.. _academia:
22

3-
For Researchers & Instructors
4-
=============================
3+
For Educators & Researchers
4+
===========================
55

66
.. _citation template: https://github.com/pythonarcade/arcade#citation
77

88
Python Arcade was created by Paul V. Craven while teaching at Simpson College.
99

10-
In addition to the primary documentation you are currently viewing,
11-
there are further resources and affordances for academic users.
12-
These include:
10+
In addition to the main Arcade 3.0 documentation you are currently reading, there
11+
are further resources to help academic users. These include:
12+
13+
* The :ref:`citation template <academia_citations>`
14+
* A companion :ref:`academia_arcade_book` by Arcade's creator
15+
* Potential 2.6.X maintenance releases to support curricula using Arcade 2.6
1316

14-
* A `citation template`_ in Arcade's GitHub landing page
15-
* An `Arcade book`_ by the framework's creator
16-
* Many third-party libraries and tutorials
1717

1818
.. _academia_citations:
1919

20-
The Citation Template
21-
---------------------
20+
Citation Template
21+
-----------------
22+
23+
Arcade provides a `citation template`_ in `BibTeX`_ format.
24+
25+
To learn more about using this template, please consult the following:
2226

23-
The `citation template`_ in the ``README.md`` uses `BibTeX`_ format.
24-
For other citation formats, please consult the appropriate style guide or
25-
converter manual.
27+
* the documentation of your reference management tool
28+
* any style guides you are required to follow
2629

2730

2831
.. _academia_version_2v3:
2932

3033
Version Considerations
3134
----------------------
35+
Most users will be better off using Arade 3.0.
3236

33-
Educators may prefer Arcade ``2.6.X`` over ``3.0.0`` due to its mature
34-
documentation.
37+
The main case for continuing to use ``2.6.X`` releases is reliance on teaching
38+
materials which have not yet been updated, including the :ref:`academia_arcade_book`.
3539

36-
The Companion Book
37-
^^^^^^^^^^^^^^^^^^
3840

39-
Arcade 2.6 has an instructor-designed `companion book <Arcade book>`_. Although
40-
the documentation you're reading now also aims to be an all-ages document, it
41-
lacks the translations and clear curriculum structure provided by the book. It
42-
integrates these with crucial materials:
41+
.. _academia_arcade_book:
4342

44-
* embedded videos demonstrating both concepts and past student projects
45-
* a gentle introduction to industry-standard tools which often intimidate CS graduates
46-
* languages and CS topics applicable at the univerity level and beyond
43+
Arcade Book
44+
^^^^^^^^^^^
4745

48-
.. list-table:: Differences from Arcade's Main Documentation
49-
:header-rows: 1
46+
The creator of Arcade wrote an `Arcade book`_ which covers Python basics in greater depth
47+
than the main Arcade documentation.
5048

51-
* - Aspect
52-
- Main Documentation
53-
- Arcade Companion Book
5449

55-
* - Near-Term Target Version
56-
- 3.0.0+
57-
- 2.6.X
50+
It may be some time until the `Arcade book`_ is updated for Arcade 3.0. Doing so requires a
51+
separate effort after the 3.0 release due to the the scale and number of changes since
52+
Arcade 2.6.
5853

59-
* - Structure Level
60-
- Low
61-
- High
6254

63-
* - Translation
64-
- None
65-
- `Swedish / Svenska <book_sv>`_, `German / Deutsche <book_de>`_
55+
Similarities to this Documentation
56+
""""""""""""""""""""""""""""""""""
6657

67-
.. _book_sv: https://learn.arcade.academy/sv/latest/
68-
.. _book_de: https://learn.arcade.academy/de/latest/
58+
Both the book and the documentation you are currently reading provide:
6959

70-
.. _2_6_maintenance:
71-
72-
2.6.X Maintenance
73-
-----------------
60+
* all-ages learning resources
61+
* gentle introductions to Python and Arcade
7462

75-
The Arcade team is exploring maintenance-only releases for 2.6.X. The goals
76-
for these releases would be the following:
77-
78-
#. Security updates
79-
#. Compatibility with newer Python versions
80-
#. Highly limited bug fixes
81-
82-
New features are not a priority unless crucial for security or compatibility.
8363

64+
Differences from this Documentation
65+
"""""""""""""""""""""""""""""""""""
8466

85-
A Computer Lab on a Budget
86-
--------------------------
67+
The book caters more heavily to beginners and educators by providing the following
68+
in a traditional chapter and curriculum structure:
8769

88-
This section is provides a starting point for educators who:
70+
#. Embedded videos covering concepts and past student projects
71+
#. Lab exercises to help apply chapter material through practice
72+
#. Translations in `Swedish / Svenska <book_sv>`_ and `German / Deutsche <book_de>`_
8973

90-
* aim to teach programming workshops for 5-15 students
91-
* have not yet acquired the hardware to do so
92-
* wish to make effective use of their budget
74+
It also offers gentle, beginner-friendly introductions to topics which can intimidate
75+
even the graduates of college-level computer science programs:
9376

94-
It is not a step-by-step guide because it is impossible to make
95-
one general enough.
77+
#. Editors and development environments
78+
#. Industry-standard version control tools
79+
#. CS topics applicable at college-level and beyond
9680

97-
General Considerations
98-
^^^^^^^^^^^^^^^^^^^^^^
9981

100-
If you do not already have network infrastructure to plug into,
101-
you may want to budget for router and a cheap switch. This isn't
102-
for multiplayer, but for downloading packages or boot images to
103-
user machines.
82+
.. _2_6_maintenance:
10483

105-
For younger students, be sure to limit unsupervised network access. You
106-
may also need to allocate time to cover the basics of file and folder
107-
structures since many students now grow up with mobile devices rather
108-
than traditional PCs.
84+
2.6.X Maintenance?
85+
------------------
10986

110-
For offline work, this list of `PyPI mirror tools`_ may be helpful.
87+
The Arcade team is exploring additional *maintenance-only* releases for 2.6.X.
11188

112-
.. _PyPI mirror tools: https://packaging.python.org/en/latest/guides/index-mirrors-and-caches/#existing-projects
89+
The goals for these still-hypothetical releases would be:
11390

91+
#. Security updates
92+
#. Compatibility with newer Python versions
93+
#. Highly limited bug fixes
11494

115-
Surplus Hardware
116-
^^^^^^^^^^^^^^^^
117-
This is often the best option and sometimes the only one.
95+
Since the Arcade team's focus is on improving Arcade 3.0, no new features will be added
96+
unless at least one of the following is true:
11897

119-
Even if a device does not have, many enterprise-oriented desktop PCs
120-
from the past decade can be revived with a low-resource Linux installation.
98+
* It is required for a security or compatibilty improvement
99+
* The effort required is minimal
121100

122101

123102
Raspberry Pi and other SBCs
124-
^^^^^^^^^^^^^^^^^^^^^^^^^^^
103+
---------------------------
125104

126-
Single-Board Computers (SBCs) such as the Raspberry Pi 4 and 5
105+
For educators, Single-Board Computers (SBCs) such as the Raspberry Pi 4 and 5
127106
are not always the most cost-effective option.
128107

129-
However, they may be worth considering when one or more of the
130-
following applies:
108+
However, they may be an attractive option when at least one of the following
109+
applies:
131110

132-
* Surplus hardware isn't an option
133111
* You have an educational discount
134112
* You have grant or non-profit funding
113+
* Surplus hardware isn't an option
114+
135115

136116
.. _sbc_rule_of_thumb:
137117

138-
SBC Rules of Thumb
139-
^^^^^^^^^^^^^^^^^^
118+
SBC Purchasing Rules of Thumb
119+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
120+
121+
.. note:: These rules help **non-experts** steer toward Arcade-copatible devices.
122+
123+
You can find more in-depth descriptions of the required OpenGL ES versions
124+
and more under the :ref:`sbc_requirements` heading.
125+
126+
127+
ARM64 and AMD64 are Easiest
128+
"""""""""""""""""""""""""""
129+
130+
The :ref:`known-working Raspberry Pi 4 and 5 <sbc_supported_raspi>` are both ARM64
131+
devices. If you are considering other boards due to price or availability, stick to
132+
the following CPU architectures:
133+
134+
* ARM64
135+
* AMD64 (same as most non-Mac desktop CPUs)
136+
137+
No RISC-based SBC has been verified as compatible. Although some *may* work,
138+
SBCs based on RISC-V CPUs are likely to lack:
139+
140+
* introductory tutorials
141+
* beginner-friendly documentation
140142

141-
ARM64 and AMD64 CPUs Will Be Easier
142-
"""""""""""""""""""""""""""""""""""
143-
RISC systems *may* work, but such SBCs do not have the same amount
144-
of beginner-friendly community around them.
145143

146144

147145
Credit Card Rule

0 commit comments

Comments
 (0)