Skip to content

Commit a4ea03e

Browse files
econchickeconchick
committed
Edit READMEs to all be consistent
1 parent 7d56e7b commit a4ea03e

File tree

6 files changed

+23
-141
lines changed

6 files changed

+23
-141
lines changed

‎apis/README.md‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,4 @@
33
### Project
44
To build a timeline using [Dipity](http://www.dipity.com) with photos from Flickr and/or 500px. For example, one could make a photo timeline grabbing photos tagged with "Olympics 2012" or "Arab Spring."
55

6-
### TODOs
7-
* write code.
8-
* write tests.
9-
* write tutorial.
10-
* be awesome.
6+
Follow the complete tutorial [here](http://newcoder.io/api)

‎dataviz/README.md‎

Lines changed: 1 addition & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -3,58 +3,4 @@
33
### Project
44
To parse data from a CSV or Excel file and plot it with matplotlib. Examples include: parsing local crime data and visualizing how often crime happens on Mondays versus Thursdays, etc.
55

6-
7-
### Initial Requirements:
8-
* [Python 2.x](http://www.python.org/download/releases/2.7.3/)
9-
* [git](http://git-scm.com/downloads)
10-
* [virtualenv](http://pypi.python.org/pypi/virtualenv) You can either download directly, or:
11-
* Mac: `$ sudo easy_install virtualenv`
12-
* Ubuntu: `$ sudo apt-get virtualenv`
13-
* Fedora: `$ sudo yum install python-virtualenv`
14-
* Windows: [Download manually](http://pypi.python.org/pypi/virtualenv)
15-
* [virtualenvwrapper](http://pypi.python.org/pypi/virtualenvwrapper) You can either download it directly, or:
16-
* Mac: `$ sudo easy_install virtualenvwrapper`
17-
* Ubuntu: `$ sudo apt-get virtualenvwrapper`
18-
* Fedora: `$ sudo yum install python-virtualenvwrapper`
19-
* For Mac, Ubuntu, and Fedora:
20-
* `$ export WORKON_HOME=~/Envs`
21-
* `$ mkdir -p $WORKON_HOME`
22-
* `$ source /usr/local/bin/virtualenvwrapper.sh`
23-
* Windows: [Download manually](http://pypi.python.org/pypi/virtualenvwrapper) and follow install instructions
24-
25-
* _Note_: If you are running zsh, check out [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh). You can easily activate <code>virualenv</code> and <code>virtualenvwrapper</code> as a plugin in your `.zshrc` file.
26-
27-
### To Run
28-
Within your terminal
29-
30-
* `$ cd` to get to your 'Home' directory
31-
* `$ mkdir Projects && cd Projects` to create a new 'Projects' folder and move to that directory. You can name it whatever you want, just remember what you named it, and where it is.
32-
* `$ git clone https://github.com/econchick/new-coder.git` This clones the New Coder project into the directory you're currently in, which is Projects (unless you named it something else).
33-
* `$ cd new-coder/dataviz` Change into the Data Viz project.
34-
* `$ mkvirtualenv DataVizProj` Make a virtual environment specific to your Data Viz project. You should see (DataVizProject) before your prompt, now.
35-
* `(DataVizProject) $ pip install -r requirements.txt` Now installing package requirements for this project. Your virtual environment will store the required packages in a self-contained area to not mess up with other Python projects.
36-
37-
#### Virtual Env Practice
38-
Just to show the ease of virtualenv and virtualenvwrapper:
39-
* `(DataVizProject) $ deactivate` You've deactivated your virtual environment. You will not have access to those packages we've downloaded until we reactivate the virtual environment again.
40-
* `$ workon DataVizProject` The virtual environment now is reactivated. The packages you previously installed are now accessible. You should see (DataVizProject) before your prompt again.
41-
* `(DataVizProject) $ pip freeze` This will show you the installed packages in this virtual environment.
42-
43-
**Don't forget** to [deactivate](#virtual-env-practice) your virtual environment after you're all done!
44-
45-
#### Full Source
46-
Within your terminal:
47-
48-
* `(DataVizProject) $ cd new-coder/dataviz/lib/full_source`
49-
* `(DataVizProject) $ python dataviz.py --csvfile=<absolute path to csv file> --type=[Days, Type, Map] --delimiter=<csv file delimiter>`
50-
51-
52-
#### Tutorial Parts
53-
Within your terminal:
54-
* `(DataVizProject) $ cd new-coder/dataviz/lib/tutorial_source`
55-
* Open the desired file (parse.py, graph.py, or map.py) in a text editor
56-
* Edit the `my_file` variable to the full path of your csv file
57-
* Save and return to your terminal
58-
* `(DataVizProject) $ python [parse.py | graph.py | map.py ]`
59-
60-
6+
Follow the complete tutorial [here](http://newcoder.io/dataviz)

‎gui/README.md‎

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,11 @@
11
## GUI
22

33
### Project
4-
Build a Sudoku game for the desktop!
54

6-
### TODOs
7-
* write code.
8-
* write tests.
9-
* write tutorial.
10-
* be awesome.
5+
This tutorial walks you through how to make the classic [Sudoku](http://en.wikipedia.org/wiki/Sudoku) game as a GUI (Graphical User Interface) using Python’s built-in GUI library, [tkinter](https://wiki.python.org/moin/TkInter).
116

7+
Follow the complete tutorial [here](http://newcoder.io/gui)
8+
9+
10+
**NOTE**: Tutorial language for testing is not yet complete, but the code for tests can be found in `sudokutest.py`.
1211

13-
### Sudoku links
14-
* http://www.sudokuwiki.org/sudoku_creation_and_grading.pdf
15-
* http://en.wikipedia.org/wiki/Sudoku
16-
* http://en.wikipedia.org/wiki/Mathematics_of_Sudoku
17-
* http://en.wikipedia.org/wiki/Algorithmics_of_sudoku
18-
* http://stackoverflow.com/questions/201461/shortest-sudoku-solver-in-python-how-does-it-work
19-
* http://kjell.haxx.se/sudoku/
20-
* http://www.opensky.ca/~jdhildeb/software/sudokugen/
21-
* http://norvig.com/sudoku.html

‎network/README.md‎

Lines changed: 5 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,8 @@
1-
TalkBackBot
2-
===========
1+
## Networks
32

4-
Are you tired of “That’s what she said” jokes? Then this bot is for you!
5-
It will join a specified channel and respond to the configured trigger phrases
6-
with what she really said, i.e. a quotation from a notable woman. It will also
7-
respond to any direct message with a quotation.
3+
### Project
4+
This tutorial walks you through how to make an [IRC bot](http://en.wikipedia.org/wiki/Internet_Relay_Chat_bot) with [Twisted](http://twistedmatrix.com). You will be introduced to testing, logging, an overview of how the internet works, as well as event-driven programming, different internet protocols, and making a portable application.
85

9-
Many quotes taken from this excellent resource:
10-
http://womenshistory.about.com/library/qu/blqulist.htm
6+
The project’s code is based off of [Jessamyn Smith](https://twitter.com/jessamynsmith)’s IRC bot – the [talkbackbot](https://github.com/jessamynsmith/talkbackbot), where if anyone says “That’s what she said” in an IRC channel, the bot replies with a notable quote from a woman (that’s what she really said!).
117

12-
Setup
13-
-----
14-
15-
I highly recommend both virtualenv and virtualenvwrapper to manage the
16-
environments for your different python projects.
17-
18-
::
19-
20-
# Create a virtualenv
21-
mkvirtualenv talkbackbot
22-
23-
# Install requirements
24-
workon talkbackbot
25-
pip install -r requirements.txt
26-
27-
Usage
28-
-----
29-
30-
::
31-
32-
# Activate your virtualenv
33-
workon talkbackbot
34-
35-
# Copy settings.ini.EXAMPLE to settings.ini and edit to suit yourself
36-
cp settings.ini.EXAMPLE settings.ini
37-
vim settings.ini
38-
39-
# Run the bot
40-
twistd -n twsrs
41-
42-
# OR if you have 'make' installed
43-
make run
44-
45-
# Optionally, you can set the config file
46-
twistd -n twsrs -c some-other-file.ini
47-
48-
# Stop the bot
49-
<Ctrl-C>
50-
51-
# Run unit tests
52-
trial tests
53-
54-
# OR if you have 'make' installed
55-
make cov
8+
Follow the complete tutorial [here](http://newcoder.io/networks)

‎scrape/README.md‎

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,4 @@
33
### Project
44
Scrape data from a regularly updated website (e.g. cafeteria's weekly lunch menu, local bank interest rates, Groupon/LivingSocial/etc deals), save to a database (postgres), hook up to a cron job, and use the Data Visualization tutorial to play with different visualization techniques.
55

6-
#### Full Source
7-
Within your terminal:
8-
9-
* Create database for storing scraped data
10-
* `(WebScraperProj) $ cd new-coder/living_social`
11-
* Edit settings.py and set your database settings
12-
* `(WebScraperProj) $ scrapy crawl livingsocial`
13-
14-
#### Running tests
15-
Within your terminal:
16-
17-
* `(WebScraperProj) $ cd new-coder/scrape/living_social`
18-
* `(WebScraperProj) $ scrapy check livingsocial`
19-
6+
Follow the complete tutorial [here](http://newcoder.io/scrape)

‎website/_containers/gui/2015-01-14-extended.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,16 @@ Like playing around with GUIs? Why not try to create:
4141
* Mailing list: [PyQt mailing list](http://www.riverbankcomputing.com/mailman/listinfo/pyqt)
4242
* Article: Some really nice and extensive [personal notes](http://phaseit.net/claird/comp.lang.python/python_GUI.html) from [Cameron Laird](https://wiki.python.org/moin/CameronLaird)
4343

44+
### Sudoku links
45+
* http://www.sudokuwiki.org/sudoku_creation_and_grading.pdf
46+
* http://en.wikipedia.org/wiki/Mathematics_of_Sudoku
47+
* http://en.wikipedia.org/wiki/Algorithmics_of_sudoku
48+
* http://stackoverflow.com/questions/201461/shortest-sudoku-solver-in-python-how-does-it-work
49+
* http://kjell.haxx.se/sudoku/
50+
* http://www.opensky.ca/~jdhildeb/software/sudokugen/
51+
* http://norvig.com/sudoku.html
52+
53+
4454

4555
<br/>
4656
<nav>

0 commit comments

Comments
 (0)