Skip to content

Commit 5ffe148

Browse files
author
Martin O'Hanlon
authored
Merge pull request #3 from mu-editor/master
Bring up to date
2 parents 8958912 + 662f6c0 commit 5ffe148

32 files changed

+1044
-109
lines changed

en/download.md

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,6 @@ i18n: en
66

77
# Download Mu
88

9-
<div class="panel panel-warning">
10-
<div class="panel-heading"><h3 class="panel-title">THIS IS BETA SOFTWARE!</h3></div>
11-
<div class="panel-body">
12-
<p>Mu is in the closing stages of a final 1.0 release. As a result it is
13-
still considered BETA software and this reflects how the installer
14-
currently works and you may encounter bugs (<a href="/en/howto/bugs">please report them!</a>).
15-
Please read the instructions for your installer for more information.</p>
16-
</div>
17-
</div>
18-
19-
209
There are many ways to install Mu. The simplest is to download the official
2110
installer for Windows or Mac OSX. If you're a more advanced user you can use
2211
Python's built-in `pip` tool. Some Linux distributions come with Mu packaged
@@ -33,8 +22,8 @@ Each option is outlined below:
3322
<img src="/img/windows_logo.png" alt="Windows Logo">
3423
<div class="caption">
3524
<h3>Windows Installer</h3>
36-
<p><a href="https://github.com/mu-editor/mu/releases/download/v1.0.0.beta.16/mu-editor_beta16_win32.exe" class="btn btn-primary" role="button">32-bit</a>
37-
<a href="https://github.com/mu-editor/mu/releases/download/v1.0.0.beta.16/mu-editor_beta16_win64.exe" class="btn btn-primary" role="button">64-bit</a>
25+
<p><a href="https://github.com/mu-editor/mu/releases/download/v1.0.0/mu-editor_1.0_win32.exe" class="btn btn-primary" role="button">32-bit</a>
26+
<a href="https://github.com/mu-editor/mu/releases/download/v1.0.0/mu-editor_1.0_win64.exe" class="btn btn-primary" role="button">64-bit</a>
3827
<a href="/en/howto/install_windows" class="btn btn-default" role="button">Instructions</a></p>
3928
</div>
4029
</div>
@@ -44,7 +33,7 @@ Each option is outlined below:
4433
<img src="/img/apple_logo.png" alt="Apple Logo">
4534
<div class="caption">
4635
<h3>Mac OSX Installer</h3>
47-
<p><a href="https://github.com/mu-editor/mu/releases/download/v1.0.0.beta.16/mu-editor_beta16_osx.dmg" class="btn btn-primary" role="button">Download</a>
36+
<p><a href="https://github.com/mu-editor/mu/releases/download/v1.0.0/mu-editor_1.0_osx.dmg" class="btn btn-primary" role="button">Download</a>
4837
<a href="/en/howto/install_macos" class="btn btn-default" role="button">Instructions</a></p>
4938
</div>
5039
</div>

en/help/1.0.md

Lines changed: 50 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,54 @@ title: Help for Mu 1.0.*
55

66
# Help for Mu 1.0
77

8-
You have three options for finding help about this version of Mu:
8+
<div class="row">
9+
<div class="col-sm-4 col-md-4">
10+
<div class="thumbnail">
11+
<a href="/en/tutorials">
12+
<img src="/img/en/tutorials/start.gif" alt="Tutorials"
13+
class="img-responsive center-block img-rounded movie-light">
14+
</a>
15+
<div class="caption">
16+
<h3>1. Tutorials</h3>
17+
<p>All the basics you need to know to get started and help with first
18+
steps in using Mu. <strong>If you only read one thing, make it
19+
this!</strong></p>
20+
<p><a href="/en/tutorials" class="btn btn-primary"
21+
role="button">Go</a> Level: <strong>SUPER EASY</strong></p>
22+
</div>
23+
</div>
24+
</div>
25+
<div class="col-sm-4 col-md-4">
26+
<div class="thumbnail">
27+
<a href="/en/howto">
28+
<img src="/img/en/help/howto.png" alt="Howto"
29+
class="img-responsive center-block img-rounded movie-light">
30+
</a>
31+
<div class="caption">
32+
<h3>2. How-to Guides</h3>
33+
<p>These deal with common tasks or problems in a simple
34+
step-by-step manner. If you're looking for something specific,
35+
look here.</p>
36+
<p><a href="/en/howto" class="btn btn-primary"
37+
role="button">Go</a> Level: <strong>INTERMEDIATE</strong></p>
38+
</div>
39+
</div>
40+
</div>
41+
<div class="col-sm-4 col-md-4">
42+
<div class="thumbnail">
43+
<a href="/en/discuss">
44+
<img src="/img/en/help/chat.png" alt="Chat"
45+
class="img-responsive center-block img-rounded movie-light">
46+
</a>
47+
<div class="caption">
48+
<h3>3. Discussion Channel</h3>
49+
<p>Our web-based chat-room is where you can ask questions or discuss
50+
My with both other users and the developers of Mu.</p>
51+
<p><a href="/en/discuss" class="btn btn-primary"
52+
role="button">Go</a> Level: <strong>ADVANCED-ish</strong></p>
53+
</div>
54+
</div>
55+
</div>
56+
</div>
957

10-
1. The [tutorials](/en/tutorials) introduce you to using Mu.
11-
They are the best place to start. The tutorial entitled
12-
"[Start Here!](/en/tutorials/1.0/start)" gives you the basics needed to get
13-
going. If you follow the tutorials, one after the other, you'll very quickly
14-
become an expert in using Mu (the tutorials themselves are *very easy* to
15-
follow).
16-
2. The [how-to guides](/en/howto/) deal with common tasks or problems in a
17-
simple step-by-step manner. If you're looking for something specific then
18-
look here.
19-
3. The [discussion channel](/en/discuss) is a web based chat-room for members
20-
of the Mu community. We expect participants to follow the Python Software
21-
foundation's [Code of Conduct](https://www.python.org/psf/codeofconduct/).
22-
The discussion channel is where you can ask questions or discuss Mu with
23-
both other users and the developers of Mu.
24-
25-
Finally, if you think you've found a bug in Mu then [follow the steps outlined here](/en/howto/bugs).
58+
**If you think you've found a bug in Mu, congratulations! Please [follow the steps outlined here](/en/howto/bugs).**

en/howto/install_macos.md

Lines changed: 56 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,76 @@
11
---
22
layout: default
3-
title: How to install Mu on Mac OSX with the Official Installer
3+
title: How to install Mu on macOS with the Official Installer
44
i18n: en
55
---
66

7-
# How to install Mu on Mac OSX with the Official Installer
7+
# How to install Mu on macOS with the Official Installer
88

9-
Since most of our users will be beginners we've made it extraordinarily easy to
10-
install Mu on Apple's Macintosh line of computers that run OSX. Mu should run
11-
on any machine running OSX version 10.10 Yosemite or later.
9+
Installing Mu on macOS is super easy.
1210

13-
First, follow the
14-
[advice on Apple's website](https://support.apple.com/en-us/HT201260) to check
15-
you're using a version of OSX that'll work with Mu (remember, it needs to be
16-
a version later than 10.10).
11+
Mu will run on any machine running macOS version 10.11 El Capitan or later. There is [advice on Apple's website](https://support.apple.com/en-us/HT201260) on how to check your macOS version.
1712

18-
Next, [download the installer for Mac OSX](/en/download).
19-
The installer itself is a disk image (a file that ends in .dmg) that you open
20-
by double clicking it. When you open the disk image your computer will check
21-
it is uncorrupted (this may take a couple of minutes).
13+
## Step 1 - Download Mu Installer
2214

23-
Once the disk image is open, follow the steps illustrated below to install Mu.
15+
+ [Download](/en/download) the installer for macOS.
16+
17+
## Step 2 - Open the Installer
18+
19+
+ Open your Downloads folder - click "Go", then "Downloads" on the Finder menu.
20+
21+
<div class="row">
22+
<img src="/img/en/howto/macos_go_downloads.png" alt="Mac OS open downloads" class="img-responsive center-block img-rounded"/>
23+
<br/>
24+
</div>
25+
26+
+ Double click the Mu installer disk image (a .dmg file).
27+
28+
<div class="row">
29+
<img src="/img/en/howto/macos_downloads.png" alt="Mac OS downloads" class="img-responsive center-block img-rounded"/>
30+
<br/>
31+
</div>
32+
33+
When you open the installer you'll be asked to accept the software license
34+
agreement and then your computer will verify the package is not corrupted (this
35+
may take a couple of minutes).
36+
37+
## Step 3 - Install Mu
38+
39+
+ Click, hold and drag the "Mu" icon into the "Applications" folder.
2440

2541
<div class="row">
26-
<h2>Step 1</h2>
27-
<p>Click, hold and drag the "Mu" icon into the "Applications" folder.</p>
2842
<img src="/img/en/howto/macos1.png" alt="Mac OSX installer step 1" class="img-responsive center-block img-rounded"/>
43+
<br/>
2944
</div>
45+
46+
## Step 4 - Installing
47+
48+
Mu will install into the Applications folder on your Mac.
49+
3050
<div class="row">
31-
<h2>Step 2</h2>
32-
<p>Mu will install into the Applications folder on your Mac.</p>
3351
<img src="/img/en/howto/macos2.png" alt="Mac OSX installer step 2" class="img-responsive center-block img-rounded"/>
3452
</div>
53+
54+
## Step 5 - Start Mu
55+
56+
+ Open your Applications folder - click "Go", "Applications" on the Finder menu.
57+
3558
<div class="row">
36-
<h2>Step 3</h2>
37-
<p>Open the Applications folder on your Mac (where all your other
38-
applications are found) and double click the Mu icon to launch the
39-
editor.</p>
40-
<img src="/img/en/howto/macos3.png" alt="Mac OSX installer step 3" class="img-responsive center-block img-rounded"/>
59+
<img src="/img/en/howto/macos_go_applications.png" alt="Mac OS open downloads" class="img-responsive center-block img-rounded"/>
60+
<br/>
4161
</div>
4262

43-
<div class="panel panel-warning">
44-
<div class="panel-heading"><h3 class="panel-title">THIS IS BETA SOFTWARE!</h3></div>
45-
<div class="panel-body">
46-
<p>Mu is in the closing stages of a final 1.0 release. As a result it is
47-
still considered BETA software and this reflects how the installer
48-
currently works. Put simply, we currently don't sign the installer so
49-
OSX complains about Mu coming from an unknown publisher. When the Mu
50-
1.0 is finally we won't have this issue.</p>
51-
52-
<p>We've outlined the extra steps needed to help OSX start Mu for the first
53-
time (you'll never have to repeat this step unless you re-install another
54-
beta version of Mu).</p>
55-
56-
<p>Once Mu is installed, as per the steps above, open the "Applications"
57-
folder, find the "mu-editor" icon then <strong>while holding down the
58-
"ctrl" key, click the icon</strong> to display the menu shown below:</p>
59-
<img src="/img/en/howto/beta/osx_beta1.png" alt="CTRL-click" class="img-responsive center-block img-rounded movie"/><br/>
60-
61-
<p>Click the "open" item on the menu.</p>
62-
63-
<p>At this point, OSX will "verify" Mu, as shown below:</p>
64-
<img src="/img/en/howto/beta/osx_beta2.png" alt="Verify Mu" class="img-responsive center-block img-rounded movie"/><br/>
65-
66-
<p>Finally, an alert (shown below) will appear. To actually launch Mu click
67-
on the "Open" button.</p>
68-
<img src="/img/en/howto/beta/osx_beta3.png" alt="Click Open" class="img-responsive center-block img-rounded movie"/><br/>
69-
<p><strong>These steps can take some time as OSX checks the Mu package, but
70-
you'll only ever have to do them once.</strong></p>
71-
</div>
63+
Double-click on the Mu icon. You'll see a dialog to check you want to open
64+
Mu. Click "Open":
65+
66+
<div class="row">
67+
<img src="/img/en/howto/open_mu_osx.png" alt="Click to Open" class="img-responsive center-block img-rounded"/><br/>
68+
</div>
69+
70+
**This can take some time as OSX checks the Mu package, but you'll only ever have to do it once.**
71+
72+
+ Next time you launch Mu you will be able to just double click the Mu icon.
73+
74+
<div class="row">
75+
<img src="/img/en/howto/macos3.png" alt="Mac OSX installer step 3" class="img-responsive center-block img-rounded"/>
7276
</div>

en/howto/install_raspberry_pi.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,26 @@ If you're using the Raspberry Pi Foundation's official
1111
operating system you should use your preferred package management application
1212
and install `mu-editor`.
1313

14-
## Step 1
14+
## Step 1 - Open a Terminal
1515

16-
Open a terminal by selecting Accessories and Terminal from the menu
16+
+ Open a terminal by selecting Accessories and Terminal from the menu
1717

1818
<div class="row">
1919
<img src="/img/en/howto/pi_open_terminal.png" alt="pi open terminal" class="img-responsive center-block img-rounded movie"/>
2020
<br/>
2121
</div>
2222

23-
## Step 2
23+
## Step 2 - Install Mu
2424

25-
Enter the following command to download and install Mu.
25+
Enter the following commands to:
26+
27+
+ Update the repositories.
28+
29+
```bash
30+
sudo apt-get update
31+
```
32+
33+
+ Download and install Mu.
2634

2735
```bash
2836
sudo apt-get install mu
@@ -33,4 +41,11 @@ sudo apt-get install mu
3341
<br/>
3442
</div>
3543

36-
Open Mu from by selecting it from the Programming menu.
44+
## Step 3 - Start Mu
45+
46+
+ Open Mu by selecting it from the Programming menu.
47+
48+
<div class="row">
49+
<img src="/img/en/howto/pi_open_mu.png" alt="pi open mu" class="img-responsive center-block img-rounded movie"/>
50+
<br/>
51+
</div>

en/howto/install_windows.md

Lines changed: 54 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ i18n: en
66

77
# How to install Mu on Windows with the Official Installer
88

9-
Installing Mu in Windows is super easy.
9+
Installing Mu in Windows is super easy (if you are a network administrator we
10+
recommend you [read the instructions at the bottom of the page](#admins)).
1011

1112
<div class="row">
1213
<img src="/img/en/howto/windows_mu_installer.gif" alt="mu windows installer" class="img-responsive center-block img-rounded movie"/>
@@ -55,18 +56,12 @@ There is also [advice on Microsoft's website](https://support.microsoft.com/en-u
5556

5657
+ Double-click the installer to run it.
5758

58-
<div class="panel panel-warning">
59-
<div class="panel-heading"><h3 class="panel-title">THIS IS BETA SOFTWARE!</h3></div>
60-
<div class="panel-body">
61-
<p>Mu is in the closing stages of a final 1.0 release. As a result it is
62-
still considered BETA software and this reflects how the installer
63-
currently works.</p>
59+
<div class="alert alert-warning" role="alert">
60+
<h3>THIS IS SOFTWARE FROM THE INTERNET!</h3>
6461

65-
<p>Put simply, we currently don't sign the installer so
66-
Windows complains about Mu coming from an unknown publisher. When the Mu
67-
1.0 is finally released the installer won't have this issue.</p>
62+
<p>Windows complains about Mu coming from the internet.</p>
6863

69-
<p>In any case, we've outlined the extra steps needed to help Windows
64+
<p>As a result, we've outlined the extra steps needed to help Windows
7065
install Mu for both Windows 7 and Windows 10 (other versions of Windows
7166
will be similar).</p>
7267

@@ -80,7 +75,6 @@ There is also [advice on Microsoft's website](https://support.microsoft.com/en-u
8075
<p>The message will change giving you more information about the installer and display a "Run anyway" button. Click
8176
"Run anyway".</p>
8277
<img src="/img/en/howto/beta/win10.3.png" alt="Click Run Anyway" class="img-responsive center-block img-rounded movie"/><br/>
83-
</div>
8478
</div>
8579

8680
## Step 3 - Start the install
@@ -107,6 +101,9 @@ Review the license and click "Agree".
107101

108102
Select if you want to install Mu for all users, or just yourself and click "Next".
109103

104+
Please note, if your user account does not have administrative rights this step might not appear on your installation process.
105+
If it does, the installer might only work if you select the "Install just for me" option.
106+
110107
<div class="row">
111108
<img src="/img/en/howto/winstall3.png" alt="Windows installer step 3" class="img-responsive center-block img-rounded movie"/>
112109
<br/>
@@ -147,3 +144,48 @@ You can start Mu by clicking on the icon in the Start menu.
147144
<img src="/img/en/howto/windows_start_mu.png" alt="Windows start mu" class="img-responsive center-block img-rounded movie"/>
148145
<br/>
149146
</div>
147+
148+
<div id="admins" class="panel panel-warning">
149+
<div class="panel-heading"><h3 class="panel-title"><strong>ATTENTION NETWORK ADMINISTRATORS</strong></h3></div>
150+
<div class="panel-body">
151+
<p>If you are a network administrator who needs to install Mu on
152+
many machines we'd like to answer a couple of common queries and provide
153+
some technical context and information:</p>
154+
155+
<dl>
156+
<dt>Why is the installer a <code>.exe</code> rather than an MSI?</dt>
157+
<dd>In 2015 Microsoft announced that, while MSI won't go away any time
158+
soon, they want developers to move onto other, more modern, packaging
159+
solutions. We use a simple and easy to use
160+
<a href="https://pynsist.readthedocs.io/en/latest/">packaging
161+
system</a> which allows us to automatically and reliably create
162+
installers with zero manual intervention.</dd>
163+
<dt>Why is the default install per-user rather than system wide?</dt>
164+
<dd>Engineers at Microsoft have
165+
<a href="https://twitter.com/zooba/status/1013445957290061824">advised
166+
us</a> that per-user is the preferred for the following reasons:
167+
<ul>
168+
<li>Non-admin users can use the installer.</li>
169+
<li>Such installations keep users isolated from each other.</li>
170+
<li>Per-user installation means security and reliability
171+
problems encountered by running as admin are avoided.</li>
172+
</ul>
173+
For more information about installation contexts, please see
174+
<a href="https://msdn.microsoft.com/en-us/library/windows/desktop/dd765197(v=vs.85).aspx">this article on Microsoft's website</a>.
175+
</dd>
176+
177+
</dl>
178+
<p><strong>We understand that, as a system administrator, you know what
179+
you're doing and simply want to install Mu, system wide, on all the
180+
machines under your control.</strong> In this case, you need
181+
to run the installer with the following flags:
182+
<code>mu-editor_win64.exe /S /AllUsers</code></p>
183+
184+
<p>The <code>/S</code> flag tells the installer to work in "silent" mode
185+
(i.e. you won't see the windows shown in the screenshots above) and the
186+
<code>/AllUsers</code> flag makes Mu available to all users of the system
187+
(i.e. it's installed "system wide").</p>
188+
<p>If you encounter problems or wish to give feedback, please
189+
<a href="/en/discuss">get in touch</a>.</p>
190+
</div>
191+
</div>

en/howto/install_with_python.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ i18n: en
88
If you already have [Python3](https://python.org/) installed on your Windows,
99
OSX or Linux machine then it is easy to install Mu with Python's
1010
built-in package manager, [`pip`](https://pip.pypa.io/en/stable/installing/).
11+
**Please note: this method does not currently work on Raspberry Pi** (use
12+
[these instructions instead](/en/howto/install_raspberry_pi)).
1113
If you're on Windows and would rather not type commands you should use the
1214
[Windows installer for Mu](install_windows) instead. If you're using OSX on a
1315
Mac and want to use the simple drag-and-drop installer instead, you should use

0 commit comments

Comments
 (0)