summaryrefslogtreecommitdiffstats
path: root/2021/talks/teach.md
blob: 18ff6b00c1bd17917ed3f3bf9ae403afe458f56a (plain) (blame)
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
[[!meta title="Using Org-mode to teach programming"]]
[[!meta copyright="Copyright © 2021 Daniel German"]]
[[!inline pages="internal(2021/info/teach-nav)" raw="yes"]]

<!-- You can manually edit this file to update the abstract, add links, etc. --->


# Using Org-mode to teach programming
Daniel German

[[!inline pages="internal(2021/info/teach-schedule)" raw="yes"]]

In this presentation I will explain how to use org-mode effectively to
prepare teaching materials, and how to present them.

For the last 5 years I have been using org-mode to teach programming
in different languages: C++, SQL, Ruby, Python, SML
and Scheme. Org-mode has three key advantages:

1.  it supports most programming languages with a common interface,
2.  it is an interactive medium for delivering teaching materials; and
3.  it is an always-up-to-date format that does not need to be exported in order to be published.

I explain how I use org-mode in my courses and how I combine org-mode
notes other tools such as github org-mode to get
always up-to-date teaching materials that one can use for both
teaching and studying (see
<https://github.com/dmgerman/csc116ModernCplusplus/blob/master/lectures/l-01-1-intro/01_1_intro.org>
for an example).

Finally, I will discuss some important aspects to consider when using
org-mode for this purpose.

# Discussion

IRC:

- how do you keep the discipline of working on your notes? that's probably my biggest problem 
- I like "Try that with PowerPoint!" as a new org-babel slogan
- we just need krita and inkscape modes
- i remember doing similar in Smalltalk using a presentation tool with in it but with a full on graphical display of the Smalltalk environment not just text based.
- I liked the trick with annotating the code in xournal -- what is the elisp glue for that? Do you have a package for that?

BBB:

- Can you talk about how the students re0act to this org-mode approach?
- What level are your students typically? what is the subject matter?
- Why GitHub? GitHub is nonfree.
  - Perhaps because gitlab is also there and that there is achoice?
  - GitHub requires reCAPTCHA to signup and similar things that are free exist (various GitLab and Gitea servers, Savannah, sourcehut).
  - GitLab.com is just as bad (and unlike GitHub, you can't sign in without nonfree JS), but GitLab CE is fine.
- Do you think org-mode+git could be used for students' assignments?


# Outline

20 minutes:

-   Introduction
-   Quick demonstration
-   Workflow
-   Some Important considerations
-   Emacs configuration and how to get started

I have create a git repository with examples and config files that is ready to use:
<https://github.com/dmgerman/teachingProgOrg>


[[!inline pages="internal(2021/captions/teach)" raw="yes"]]

[[!inline pages="internal(2021/info/teach-nav)" raw="yes"]]