Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mikeizbicki/ucr-cs100

open source software construction course
https://github.com/mikeizbicki/ucr-cs100

Last synced: 5 days ago
JSON representation

open source software construction course

Awesome Lists containing this project

README 

        
## cs100 - open source software construction



This is a course on [how to be a hacker](http://www.catb.org/esr/faqs/hacker-howto.html).

Being a hacker [means a lot of things](http://www.catb.org/jargon/html/H/hacker.html).

It means:



1. wanting to know *how* and *why* computers work



2. being efficient / never repeating yourself



3. using and contributing to open source software



4. understanding the edge cases of your software



5. using tools in creative and unexpected ways



6. (occasionally) we combine all these together and break stuff



Hacking is a mindset.

I can't force it on you---it's up to you to embrace it.

For example, we'll be discussing many new tools in this course:

a version control system called `git`,

an editor called `vim`,

debugging tools called `gdb`, `valgrind`, and `cppcheck`,

and we'll be going into quite a bit more depth on how to use the `bash` shell and the `Linux` operating system.

All of these tools are very weird.

Using them will make you uncomfortable.

At first.

But these tools are powerful.

Mastering these tools will make you a *much* more efficient programmer.

Once you've mastered them, you'll never go back.



There are two main projects you will work on in this course:



1. Your first four homework assignments walk you through the process of building your own unix shell.

This is the biggest project you've undertaken so far.

You'll be developing it as an open source project,

and you will collaborate with each other at various points.



2. Your last homework assignment is to contribute to the open source community by improving the documentation on a project of your choice.

Many of the required readings for this course were written by former cs100 students.

If you do a good job on this project, future cs100 students will be learning from you for years to come!



By the end of the course, you should be comfortable running your own open source projects and contributing to other people's projects.



### instructors



position | name | office hours (WCH 110)

--- | --- | ---

lecturer | |

teaching assistant | |



**IMPORTANT:**

If you want to contact the instructors about the course, you should report an issue via github.

We will talk about how to do this in class.

This is a system similar to the piazza system you may already be familiar with,

but it is more popular for open source software development.



### course schedules



Our lectures will roughly follow this schedule.

You should do the required readings before class.

I will occasionally have unscheduled quizzes to ensure you are doing the reading.



week | date | reading | topics

--- | --- | --- | ---

1 | | Daniel Lemire's [how to learn efficiently](http://lemire.me/blog/archives/2014/12/30/how-to-learn-efficiently/) (recommended; not required) | introduction; using vim

1 | | ESR's [all about unix](http://www.catb.org/esr/writings/taoup/html/context.html) | version control with git

1 | | ESR's [about common software licenses](http://www.catb.org/esr/writings/taoup/html/ch16s07.html); the New Yorker's [30 year retrospective on the GNU manifesto](http://www.newyorker.com/business/currency/the-gnu-manifesto-turns-thirty?intcid=mod-latest) | version control with git

2 | | Paul Graham's [what to do in college](http://www.paulgraham.com/college.html) | version control with git

2 | | Ian Malpass's [advice to future software engineers](https://medium.com/@indec/advice-to-future-software-engineers-64a29669d179); Linus Tolvalds [gets interviewed on why he developed git](http://www.linux.com/news/featured-blogs/185-jennifer-cloer/821541-10-years-of-git-an-interview-with-git-creator-linus-torvalds) | version control with git

2 | | Lucas Xu's [Makefile tutorial](textbook/tools/make); Alexander Ortiz's [how to write a README file](textbook/bestpractices/WritingREADMEs); ESR's thoughts on [unix documentation part I](http://www.catb.org/esr/writings/taoup/html/ch18s02.html) and [part II](http://www.catb.org/esr/writings/taoup/html/ch18s06.html) | syscalls: managing processes (`fork`,`wait`,`exec`,`perror`); **quiz**

3 | | the relevant sections of the [syscalls tutorial](textbook/assignment-help/syscalls) | syscalls: managing processes (`fork`,`wait`,`exec`,`perror`)

3 | | [bitwise operators](textbook/assignment-help/bitwise-ops); [macros](textbook/assignment-help/macros) | syscalls: managing files (`open`,`close`,`read`,`write`)

3 | | the relevant sections of the [syscalls tutorial](textbook/assignment-help/syscalls)  | syscalls: managing files (`open`,`close`,`read`,`write`)

4 | | William Coates' [valgrind tutorial](textbook/tools/valgrind); | debugging tools (`gdb`,`valgrind`,`cppcheck`)

4 | | Jeff Atwood's [how to become a better programmer](http://blog.codinghorror.com/how-to-become-a-better-programmer-by-not-programming/) | debugging tools (`gdb`,`valgrind`,`cppcheck`)

4 | | the relevant sections of the [syscalls tutorial](textbook/assignment-help/syscalls) | syscalls: managing directories (`readdir`,`stat`);**quiz**

5 | | Ycombinator's [startup ideas we'd like to fund](http://old.ycombinator.com/ideas.html) and Paul Graham's [start up funding](http://paulgraham.com/startupfunding.html)| shell scripting: io redirection/piping

5 | | Patrick McKenzie [on salary negotiation for programmers](http://www.kalzumeus.com/2012/01/23/salary-negotiation/) (it's long; you don't have to read it all)| shell scripting: io redirection/piping

5 | | Shubhro Saha's [why engineers should write](http://www.shubhro.com/2014/12/27/software-engineers-should-write/); the economist's [good writing style](http://www.economist.com/styleguide/introduction) | writing good documentation

6 | | | syscalls: io redirection/piping (`pipe`,`dup`)

6 | | the relevant sections of the [syscalls tutorial](textbook/assignment-help/syscalls) | syscalls: io redirection/piping (`pipe`,`dup`)

6 | | ESR's classic [Master Foo series](http://www.catb.org/esr/writings/taoup/html/unix_koans.html) | shell scripting: control flow with `if` and `for`; **quiz**

7 | | [regular expressions](textbook/tools/bash/regex#regular-expressions) | shell scripting: environment variables (`export`,`PATH`,`HOME`,`EDITOR`)

7 | | | shell scripting: environment variables (`export`,`PATH`,`HOME`,`EDITOR`)

7 | | | syscalls: signal handling (`signal`,`sigaction`)

8 | | | syscalls: signal handling (`signal`,`sigaction`)

8 | | the relevant sections of the [syscalls tutorial](textbook/assignment-help/syscalls) | shell scripting: environment variables (`export`,`PATH`,`HOME`,`EDITOR`)

8 | | | syscalls: environment variables (`getenv`,`setenv`); **quiz**

9 | | |

9 | | |

9 | | ESR's thoughts on [flaws with unix](http://www.catb.org/esr/writings/taoup/html/ch20s03.html); Poul-Henning Kamp's [a generation lost in the bazaar](https://queue.acm.org/detail.cfm?id=2349257&ref=fullrss) | the flaws of Unix and open source

10 | | | case study: hacking the email system and the [ioccc.org](http://ioccc.org)

10 | | | case study: stuxnet and heartbleed

10 | | | **final quiz**



If there's something you want to learn not on the schedule, let me know!

We have a lot of flexibility in this course to learn fun things.



The assignments are due on the following days:



assignment                                      | due date

----------------------------------------------- | --------------------------------------------

[hw0](assignments/hw/hw0-rshell)                |

[hw1](assignments/hw/hw1-ls)                    |

[hw4](assignments/hw/hw4-contributing) - topic  |

[hw2](assignments/hw/hw2-piping)                |

[hw4](assignments/hw/hw4-contributing) - draft  |

[hw3](assignments/hw/hw3-signals)               |

[hw4](assignments/hw/hw4-contributing) - final  |



You will receive -10 pts for each hour (rounded up) that your assignment is late.



### grades



We will not be using ilearn in this course.

Instead, we will be using a course management system called `gitlearn`.

This software was developed in part by previous cs100 students,

and you will be able to earn considerable extra credit by contributing to it.

We will be using this system as a case study in bash programming and the unix philosophy.

For details, see the [gitlearn repo](https://github.com/mikeizbicki/gitlearn).



### cheating policy



Every assignment specifies different collaboration policies.

Some assignments will be individual, and some will be in a group.

Follow the specified policy exactly!



I take cheating seriously.

When I catch students cheating, I give them an F in the class.

Then I forward your case to the academic integrity board and recommend that you be expelled from UCR.



All of your code will be run through an automated cheating detector.

It is very good.

It understands C++ better than you do and can find instances of cheating much more sophisticated than just copy and pasting.