1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
.. mu documentation master file, created by
sphinx-quickstart on Thu Dec 24 16:24:33 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Mu: A Python Code Editor
========================
.. image:: logo.png
.. note::
**This documentation is NOT for users of Mu**. Rather, it is for software
developers who want to improve Mu. Read our :doc:`setup` documentation for
the technical details needed to get started.
For tutorials, how-to guides and user related discussion, please see the
project's website for users of Mu at: https://codewith.mu/
If you're interested in the fun, educational, inspiring and sometimes
hilarious ways in which people use Mu, check out: https://madewith.mu/
Quickstart
----------
Mu works with Python 3.6 or above.
Clone the repository::
git clone https://github.com/mu-editor/mu.git
Make a virtualenv, then install the requirements::
pip install -r requirements.txt
Start Mu::
python run.py
Run the test suite::
make check
Read on to learn more about Mu, its aims and how you can contribute.
What?
-----
Mu is a very simple Python editor for kids, teachers and beginner programmers.
It's written in Python and works on Windows, OSX, Linux and Raspberry Pi.
"[Papert] realized, 'Oh, we could take the real content out here as a
version in the child's world that is still the real thing.' It's not a fake
version of math. It's kind of like little league, or even T-ball. In sports
they do this all the time. In music, they do it all the time. The idea is,
you never let the child do something that isn't the real thing -- but you
have to work your ass off to figure out what the real thing is in the
context of the way their minds are working at that developmental level."
-- `Alan Kay <https://www.fastcompany.com/40435064/what-alan-kay-thinks-about-the-iphone-and-technology-now>`_
Mu aspires to be "the real thing" as a development environment for beginner
programmers taking their first steps with Python.
As a rule of thumb, if you're able to ask "why doesn't Mu have [feature X]?"
then you're probably too advanced for using Mu as a development environment. In
which case, you should graduate to a more advanced editor.
Why?
----
There isn't a cross platform Python code editor that is:
* Easy to use;
* Available on all major platforms;
* Well documented (even for beginners);
* Simply coded;
* Currently maintained; and,
* Thoroughly tested.
Mu addresses these needs.
Mu was originally created as a contribution from the
`Python Software Foundation <http://python.org/psf>`_
for the BBC's `micro:bit project <http://microbit.org/>`_. Many people asked if
Mu could be turned into a generic beginner's code editor and, thanks to the
wonderful support of the `Raspberry Pi Foundation <http://raspberrypi.org/>`_
the work needed to make such changes was done over the summer of 2017.
`This video <https://www.youtube.com/watch?v=T5IAf5vGGSk>`` of a talk given
at `PyCon 2018 <https://us.pycon.org/2018/>` outlines the story of Mu.
How?
----
Mu's outlook is:
* Less is more (remove all unnecessary distractions);
* Keep it simple (so Mu is easy to understand);
* Walk the path of least resistance (Mu should be easy to use);
* Have fun (learning should be a positive experience).
Mu's own code is simple, clearly organised and well tested. It's copiously
commented and mostly found in a few obviously named Python files.
This has been done on purpose: we want teachers and kids to take ownership of
this project and organising the code in this way aids the first steps required
to get involved.
If you're looking for ways to get involved check out some of the
:doc:`first-steps` for new contributors.
Furthermore, we put our users at the centre of our development work. Extensive
interviews with teachers, observations of lessons and exceptionally clear and
helpful feedback from the education team at the Raspberry Pi Foundation
(perhaps the most successful computing in education project in history) have
informed the design choices for Mu.
Who?
----
**You!**
Contributions are welcome without prejudice from *anyone* irrespective of
age, gender, religion, race or sexuality. If you're thinking, "but they don't
mean me", *then we especially mean YOU*. Good quality code and engagement
with respect, humour and intelligence wins every time.
Read about :doc:`contributing` and perhaps try out some :doc:`first-steps`.
We want the Mu community to be a friendly place. Therefore, we expect
contributors to follow our :doc:`code_of_conduct`.
Contents:
---------
.. toctree::
:maxdepth: 2
contributing.rst
code_of_conduct.rst
setup.rst
first-steps.rst
user-experience.rst
architecture.rst
modes.rst
translations.rst
debugger.rst
tests.rst
packaging.rst
website.rst
api.rst
design.rst
release.rst
roadmap.rst
authors.rst
changes.rst
license.rst
copyright.rst
|
