Skip to content

Commit

Permalink
Fix #41: update M269 instructions (#48)
Browse files Browse the repository at this point in the history
  • Loading branch information
@mwermelinger
mwermelinger authored Aug 28, 2024
1 parent f71eee0 commit 4dd54fc
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 66 deletions.
53 changes: 9 additions & 44 deletions docs/getting-started-m269/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -430,15 +430,6 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#install-software-optional" class="md-nav__link">
<span class="md-ellipsis">
Install software (optional)
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#copy-an-essay-template" class="md-nav__link">
<span class="md-ellipsis">
Expand Down Expand Up @@ -868,15 +859,6 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#install-software-optional" class="md-nav__link">
<span class="md-ellipsis">
Install software (optional)
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#copy-an-essay-template" class="md-nav__link">
<span class="md-ellipsis">
Expand Down Expand Up @@ -932,31 +914,14 @@


<h1 id="getting-started-m269">Getting started (M269)</h1>
<p class="fs-6 fw-300">If you&rsquo;re an M269 student, follow these steps to start writing essays within a few minutes.</p>
<h2 id="install-software-optional">Install software (optional)</h2>
<p>While you can write essays with your current M269 software,
we recommend installing two more packages to help you
test, check the style, and measure the run-time of code.</p>
<ol>
<li>Activate your M269 environment as usual:<ul>
<li>Open a PowerShell (Windows) or terminal (Linux / macOS), and enter <code>m269-23j</code>.</li>
<li>The prompt should now be <code>(m269-23j) ...</code> and you should be in your M269 folder.</li>
</ul>
</li>
<li>
<p>To install the software, enter <code>pip install algoesup ruff</code> in the PowerShell / terminal.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>You also need the most recent version of <code>allowed</code>, which is available
from the Resources tab of the M269 website.</p>
</div>
</li>
</ol>
<p class="fs-6 fw-300">If you&rsquo;re an M269 24J student, follow these steps to start writing essays within a few minutes.</p>
<p>These instructions assume you have already created your M269 folder and
installed the M269 software.</p>
<h2 id="copy-an-essay-template">Copy an essay template</h2>
<p>We have created templates to serve as starting points for your essay.</p>
<ol>
<li>Go to our <a href="../example-essays/">example essays</a> page.</li>
<li>Choose a template and <em>right</em>-click on the corresponding download button.</li>
<li>Go to our <a href="../example-essays/#jewels-and-stones">Jewels and Stones</a> example.</li>
<li><em>Right</em>-click on the template download button.</li>
<li>Select &lsquo;Download / Save file as&hellip;&rsquo; and save the template to your M269 folder,
with a filename that includes your name (e.g. <code>essay-Michael.ipynb</code>)
or that indicates the topic (e.g. <code>balanced-brackets.ipynb</code>).
Expand All @@ -967,8 +932,8 @@ <h2 id="write-the-essay">Write the essay</h2>
you do with the book&rsquo;s chapters and your TMAs.</p>
<ol>
<li>Open a PowerShell or terminal.</li>
<li>Enter <code>m269-23j</code> to activate your M269 environment and go to your M269 folder.</li>
<li>Enter <code>nb</code> to open the Jupyter dashboard, from which you can open the essay.</li>
<li>Enter <code>m269-24j</code> to activate your M269 environment and go to your M269 folder.</li>
<li>Enter <code>nb</code> to open the Jupyter dashboard, from which you can open the essay template.</li>
</ol>
<p>For guidance on writing algorithmic essays see our <a href="../writing/">writing</a> and
<a href="../coding/">coding</a> guides.</p>
Expand All @@ -977,8 +942,8 @@ <h2 id="share-the-essay">Share the essay</h2>
make a post in the VLE forum corresponding to the topic of your essay,
and attach your notebook file.</p>
<p>For example, if your essay is about ordered or unordered collections,
post it in the Weeks 1-10 forum, but if it also uses recursion or a sorting algorithm,
post it in the Weeks 11–20 forum.</p>
post it in the Chapters 1-10 forum, but if it also uses recursion or a sorting algorithm,
post it in the Chapters 11–20 forum.</p>
<p>Once you have addressed others&rsquo; feedback, post the final version of your essay,
acknowledging the commenters.</p>
<h2 id="publish-the-essay-optional">Publish the essay (optional)</h2>
Expand Down
2 changes: 1 addition & 1 deletion docs/search/search_index.json
View file

Large diffs are not rendered by default.

Binary file modified docs/sitemap.xml.gz
View file
Binary file not shown.
30 changes: 9 additions & 21 deletions src/docs/getting-started-m269.md
View file
Original file line number Diff line number Diff line change
@@ -1,29 +1,17 @@
# Getting started (M269)

If you're an M269 student, follow these steps to start writing essays within a few minutes.
If you're an M269 24J student, follow these steps to start writing essays within a few minutes.
{: .fs-6 .fw-300}

## Install software (optional)

While you can write essays with your current M269 software,
we recommend installing two more packages to help you
test, check the style, and measure the run-time of code.

1. Activate your M269 environment as usual:
- Open a PowerShell (Windows) or terminal (Linux / macOS), and enter `m269-23j`.
- The prompt should now be `(m269-23j) ...` and you should be in your M269 folder.
2. To install the software, enter `pip install algoesup ruff` in the PowerShell / terminal.

!!! note
You also need the most recent version of `allowed`, which is available
from the Resources tab of the M269 website.
These instructions assume you have already created your M269 folder and
installed the M269 software.

## Copy an essay template

We have created templates to serve as starting points for your essay.

1. Go to our [example essays](example-essays.md) page.
2. Choose a template and _right_-click on the corresponding download button.
1. Go to our [Jewels and Stones](example-essays.md#jewels-and-stones) example.
2. _Right_-click on the template download button.
3. Select 'Download / Save file as...' and save the template to your M269 folder,
with a filename that includes your name (e.g. `essay-Michael.ipynb`)
or that indicates the topic (e.g. `balanced-brackets.ipynb`).
Expand All @@ -35,8 +23,8 @@ With the essay template in your M269 folder, you can work on it in the same way
you do with the book's chapters and your TMAs.

1. Open a PowerShell or terminal.
2. Enter `m269-23j` to activate your M269 environment and go to your M269 folder.
3. Enter `nb` to open the Jupyter dashboard, from which you can open the essay.
2. Enter `m269-24j` to activate your M269 environment and go to your M269 folder.
3. Enter `nb` to open the Jupyter dashboard, from which you can open the essay template.

For guidance on writing algorithmic essays see our [writing](writing.md) and
[coding](coding.ipynb) guides.
Expand All @@ -48,8 +36,8 @@ make a post in the VLE forum corresponding to the topic of your essay,
and attach your notebook file.

For example, if your essay is about ordered or unordered collections,
post it in the Weeks 1-10 forum, but if it also uses recursion or a sorting algorithm,
post it in the Weeks 11–20 forum.
post it in the Chapters 1-10 forum, but if it also uses recursion or a sorting algorithm,
post it in the Chapters 11–20 forum.

Once you have addressed others' feedback, post the final version of your essay,
acknowledging the commenters.
Expand Down

0 comments on commit 4dd54fc

Please sign in to comment.