Skip to content

Instantly share code, notes, and snippets.

@elipousson

elipousson/2016-06-02-bLAMclass-GitHub-workshop.md

Last active June 2, 2016 22:21
Show Gist options
  • Star 2 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save elipousson/e99827e24440a1e41738d8e9a8142cc0 to your computer and use it in GitHub Desktop.
Save elipousson/e99827e24440a1e41738d8e9a8142cc0 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
2016-06-02-bLAMclass-GitHub-workshop.md

bLAM Class: GitHub and Open Source

This workshop is for you if …

At the end of this lesson, you will…

  • Have made a “commit” to a repository on GitHub
  • Submitting a “pull request” to a shared repository

Requirements: A computer (Mac/Windows), the ability to download and install software on the computer, an internet connection that can support downloading software.

Difficulty level: Beginner (we will not use the command line for this workshop).

Examples for workshop planning

Note: I am planning to set up either a workshop website (e.g. Software Carpentry template) or a more simple collection of Markdown files (e.g. this CUNY workshop on Git/GitHub) on the bLAM collective account. We also need a repository or a place within the workshop repository for students to contribute (Software Carpentry recommends setting up a separate repo). I’m working to put together a first draft of notes/slides by May 20, 2016. The workshop will be held on June 2, 2016.

Before the workshop

  1. Set up a GitHub account

Optional

  1. Download the GitHub desktop client (available for Mac or Windows)
  2. Download a terminal application (e.g. iTerm)
  3. Download and install a desktop text editor (e.g. Atom)

Getting Started with GitHub

Why use GitHub?

Ask participants: why are you here? Why do you want to use GitHub?

Share: Here are a few reasons that people and organizations are using GitHub.

How are GLAMs using GitHub?

  • Data
  • Writing
  • Websites
  • Maps

Key Concepts

  • Open source
  • Version control
  • Plain text

Why use open licensing?

Note: I started writing a post on open licensing and preservation organizations that may have some relevant links to bring into this section.

What is version control?

Related Links

Getting started with GitHub

Why use plain text?

Getting started with Markdown

Markdown Tutorial:

Markdown is a way to write content for the web. It’s written in what nerds like to call “plaintext,” which is exactly the sort of text you’re used to writing and seeing. Plaintext is just the regular alphabet, with a few familiar symbols, like asterisks ( * ) and backticks ( ` ). Unlike cumbersome word processing applications, text written in Markdown can be easily shared between computers, mobile phones, and people. It’s quickly becoming the writing standard for academics, scientists, writers, and many more. Websites like GitHub and reddit use Markdown to style their comments. If you have ten minutes, you can learn Markdown!

Fun Stuff!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment