Skip to content

Commit

Permalink
Merge pull request #25 from phette23/revise
Browse files Browse the repository at this point in the history
remove references to unbuilt projects, limit scope of project
  • Loading branch information
thatandromeda committed Aug 25, 2014
2 parents 30e025e + a2eea34 commit 831fa3b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 28 deletions.
2 changes: 1 addition & 1 deletion Getting Started/readme.mdown
Expand Up @@ -168,7 +168,7 @@ Someone from the Libcodeyear organization will review your pull request and acce

## Sixth Step - View the project online & see your changes!

You just contributed to a project on GitHub, congratulations! Pretty cool, isn't it? In the future, we hope to have further projects which are more complicated and necessitate using some of Git's advanced features. For now, relax and get yourself a delicious beverage, you've earned it.
You just contributed to a project on GitHub, congratulations! Pretty cool, isn't it? Relax and get yourself a delicious beverage, you've earned it.

## I'm addicted; where can I do more?

Expand Down
32 changes: 5 additions & 27 deletions readme.mdown
Expand Up @@ -6,38 +6,16 @@ You do not have to be a member of the Library Code Year Interest Group to partic

## What do I do here?

We will have three projects in this repository eventually:

>1. A "getting started" project to get you rolling with GitHub
2. A web design project involving HTML/CSS/JavaScript
3. A metadata project.

- To get started: follow the instructions in [the getting started](https://github.com/LibraryCodeYearIG/Codeyear-IG-Github-Project/blob/master/Getting%20Started/readme.mdown) project. This will have you install git, set up an account on GitHub, and contribute to this repository.
- Web Design - project TBD! We've discussed something using the [Worldcat Search API](http://www.oclc.org/worldcatapi/default.htm), which could be easily reused at almost any library.
- Metadata - project TBD! We've discussed working with Linked Data, specifically the [Friend-of-a-Friend](https://en.wikipedia.org/wiki/FOAF_(software)) ontology. Perhaps working with sample MARC records with the [pymarc](https://github.com/edsu/pymarc) or [ruby-marc](https://github.com/ruby-marc/ruby-marc) libraries, too.

## Very Much Under Construction

If the two "TBD" projects didn't clue you in, this repository is still a long ways from being complete. See below for how to help.

## I'm already a git master, how can I help?

Awesome! Thanks for offering.

You can answer people's questions in the issue queue or propose projects for people to work on. Does something not make sense? Are the instructions inaccurate or poorly written? Do you have more resources on learning git? Send a pull request! We'll be happy to include your ideas.

Right now the biggest priority is finishing the "Getting Started" project so that people can get up and running with git and GitHub.
Follow the instructions in [the getting started](https://github.com/LibraryCodeYearIG/Codeyear-IG-Github-Project/blob/master/Getting%20Started/readme.mdown) project. This will have you install git, set up an account on GitHub, and contribute to this repository.

## What is Markdown?

[Markdown](http://daringfireball.net/projects/markdown/basics)—the language this readme is written in—is a markup language, like HTML and XML, designed to be lightweight and easy to type quickly. Markdown files typically end in .md, .mdown, or .markdown. GitHub uses markdown as its preferred format for displaying readme files like this one.

The full Markdown syntax documentation is [here](http://daringfireball.net/projects/markdown/syntax) and the GitHub-flavored documentation is [here](http://github.github.com/github-flavored-markdown/). The GitHub syntax is almost identical; one can get by without ever referencing its documentation. The most useful piece is highlighting specific programming languages like so:
The full Markdown syntax documentation is [here](http://daringfireball.net/projects/markdown/syntax) and the GitHub-flavored documentation is [here](http://github.github.com/github-flavored-markdown/). The GitHub syntax is almost identical; one can get by without ever referencing its documentation. There's also [a nice cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) in adam-p's [markdown-here](https://github.com/adam-p/markdown-here) repo.

```javascript
// your code goes here
```
## I'm already a git master, how can I help?

The JavaScript inside that block would be syntax-highlighted appropriately.
Awesome! Thanks for offering.

There's also [a nice cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) in adam-p's [markdown-here](https://github.com/adam-p/markdown-here) repo.
You can answer people's questions [in the issues queue](https://github.com/LibraryCodeYearIG/Codeyear-IG-Github-Project/issues) or create new lessons for people to work on. Does something not make sense? Are the instructions inaccurate or poorly written? Do you have more resources on learning git? Send a pull request! We'll be happy to include your ideas.

0 comments on commit 831fa3b

Please sign in to comment.