initial revamp commit

Author: scottopell

README.md

@@ -21,116 +21,100 @@ export EDITOR="pluma"
 ```
 > This only lasts as long as the terminal window you ran it within. As soon as you close the window, this setting is lost.
 
-### Repository Setup
-#### Do WITH partner on ONE computer
-
-1. Fork this repository
-    
-    > Forking a repo
-
-    > ![*Creating a Repo*](https://github.com/PurdueCS190/lab7/blob/master/res/fork_repo.jpg)
-
-    > Note: This time we are forking, but you can also create a brand new repository by clicking the
-      plus button at the top of your screen and following the instructions.
-
-2. Add your partner as a collaborator
+### Git Setup
+Required since git 2.0, it defines how the pushing mechanism works. This is the most intuitive option.
+```bash
+git config --global push.default simple
+```
 
-    > Go to the repo settings
+### Creating, Committing, and Pushing
+Choose a partner to start this project off.
 
-    > ![*Go to the repo's settings*](https://github.com/PurdueCS190/lab7/blob/master/res/repo_settings.jpg)
+Agree on who is partner #1 and partner #2
+#### Do WITH partner on partner #1's computer
 
-    > Add your partner as a collaborator
+1. In your home directory, create a new folder named `cs190lab7_<your_username>`.  Ex. I would create a folder `cs190lab7_sopell`.
 
-    > ![Add your partner](https://github.com/PurdueCS190/lab7/blob/master/res/add_collab.jpg)
+  ```bash
+  mkdir ~/cs190lab7_$USER
+  ```
 
-### Clone the Repository
-#### Do on both computers
+2. You will then `cd` into the directory created above and `init`ialize a new git repository.
 
-1. Copy the clone URL from Github to your clipboard. There is a special button that makes it very simple to do this.
-Make sure that the HTTPS protocol is selected *(Bonus: See end of lab for instructions to set up SSH keys)*
+   ```bash
+   cd ~/cs190lab7_$USER
+   git init
+   ```
 
-2. Navigate to your home directory
+3. Download this template file [`calc.py`](./calc.py) into the repository you just created
 
-3. Create and navigate to a new directory called `cs190/`
-    
-```bash
-mkdir cs190/
-cd cs190/
-```
+  ```bash
+  wget -O ~/cs190lab7_$USER/calc.py https://github.com/purduecs190/lab7/raw/master/calc.py
+  ```
 
-4. Run the command `$ git clone <clone URL>` pasting in the URL you just copied
+4. `add` this file to the repo
 
-5. Navigate into the repository
+  ```bash
+  git add <filename>
+  ```
 
-When the repository is cloned, the `origin` remote, is automatically created as the the location you cloned
-from. Run the command `$ git remote -v`. You get output that looks something like:
+5. Log in to github (upper right hand corner of this page)
 
-```bash
-origin  https://github.com/<username>/lab7.git (fetch)
-origin  https://github.com/<username>/lab7.git (push)
-```
+6. Create a new repository
+  ![new repo button](http://i.imgur.com/Lhj1dUJ.png)
 
-### Run the Script
+7. Enter in a repository name and do **not** check the box that says initialize with README.
 
-To run the calculator script, run the command `$ python calc.py`. The program will prompt you to enter input. Notice
-That addition works, but all the other operations return 0. You will implement them today.
+8. Go to the repository settings
+  ![settings location](http://i.imgur.com/qJAv62R.png)
 
-### Implement the Calculator
+9. Add your partner as a collaborator.
 
-Now it is time to implement. Follow these instructions carefully.
 
-1. Open up `calc.py` in your text editor (`$ pluma calc.py &`)
+## Move to Partner #2's computer
+Partner 2 needs a copy of this repo. If you remember from lecture, this is exactly what `clone` does.
 
-2. Implement the functions that do subtraction, multiplication, and division.
+  ```bash
+  git clone <remote url>
+  cd <repo name>
+  ```
 
-    > __Partner 1__:
+For the rest of this lab, pay attention to which section you're supposed to do.
 
-    * Implement __*sub(a, b)*__ and __*mult(a, b)*__.
 
-    * For multiplication, you must use the add operator (+) and a for loop.
+## **Both** partners independently
+### Run the Script
 
-      *Hint*: in Java you may implement this
-        
-        ```Java
-        int mult(int a, int b) {
-            int result = 0;
-            for (var i = 0; i < a; i++) {
-                result += b;
-            }
-            return result;
-        }
-        ```
+To run the calculator script, run the command `$ python calc.py`. The program will prompt you to enter input. Notice that there are 4 functions defined, `+, -, * and /`
 
-      In Python, to iterate *n* times, you can do
+### Implement New Operations
+By the time you're done, you'll have two new operators, modulus division and exponentiation.  One partner will do each.
 
-        ```Python
-        for i in range(n):
-            print i
-        ```
+> Note: If you have any questions about Python syntax, ask your TA. It should be very straightforward.
 
-    > __Partner 2__:
+> Be sure to test your code to make sure your functions work the way that they should.
 
-    * Implement __*mult(a, b)*__ and __*div(a, b)*__.
 
-    * For multiplication, you may use the multiply operator (*)
+1. Open up `calc.py` in your text editor (`$ pluma calc.py &`)
 
-    > Notice that you will both be implementing __*mult(a, b)*__.
+### Partner 1 only
+2. Implement modulus division operator (%)
 
-    > Note: If you have any questions about Python syntax, ask your TA. It should be very straightforward.
+  > hint: what you're doing is very very similar to the div operator, but instead of using `/` to do regular division, you can use the `%` operator to do modulus division.
 
-    > Be sure to test your code to make sure your functions work the way that they should.
+### Partner 2 only
+2. Implement the exponent operator (**)
+  > hint: what you're doing is very very similar to the multiplication operator, but instead of using `*`, you can use the `**` operator.
 
 3. When you are done with your implementation, commit your changes
 
-    > Remeber `git add` and `git commit`. Be sure to check `git status` and `git log` afterward to make sure you
-      successfully commited the changes.
+    > Remember `git add` and `git commit`. Be sure to check `git status` and `git log` afterward to make sure you successfully committed the changes.
 
 4. Do a git pull to check for any changes. Run `$ git pull origin master`
 
-    > If you are the second partner to finish your implementation, you will get a merge conflict. Don't panic. Skip to the
-      next section and fix it together with your partner.
+    * If you are the second partner to finish your implementation, you will get a merge conflict. Don't panic. Skip to the next section and fix it together with your partner.
 
-    > If you are the first partner to finish your implementation, move on to step 5.
+    * If you are the first partner to finish your implementation, move on to step 5.
 
 5. Do a git push to publish your changes to Github so your partner can see them. Run `$ git push origin master`
 
@@ -160,25 +144,6 @@ This is because both of you implemented the __*mult(a, b)*__ function. Let's fix
 Now both of you should be able to run `$ python calc.py` on your separate computers and have a fully functioning
 calculator CLI.
 
-### Participating in open source
-
-Open source projects are a great way to get experience in the computer science community. Not only are they free and fun to work on,
-but contributions to open source are serious resume items that companies will love to see. Github is one of the biggest open source
-hosting platforms out there.
-
-When contributing to open source projects, you have to fork the repository. This gives you a copy of the repository on your own
-account where you have the permissions to change things. If you create a feature that you think is worth adding to the main project,
-you can submit a pull request and the maintainers of the project can merge in your changes. Lots more information on contributing
-to open source can be found [here](https://guides.github.com/activities/contributing-to-open-source/).
-
-1. Find an open source project on Github that interests you. Some good ideas [here](https://github.com/explore)
-
-2. Fork the repository (the same way you did earlier in the lab)
-
-3. Clone the forked repository to your machine
-
-Now your all set! If you want to contribute to the project you have the knowledge and tools to do so.
-
 ### Grading
 
 * Run `$ git log -3` and show it to your TA
@@ -194,6 +159,6 @@ you are using the HTTPS protocol to connect to Github as a remote. This has a fe
 * It will still work on strict firewalls and proxies such as those restricting all ports but port 80
 
 The downside is that you don't want to have to enter your credentials everytime you push and pull. There is another way. You
-can set up the remote to use SSH instead of HTTPS. SSH uses RSA encryption which you can set up to be passwordless using 
+can set up the remote to use SSH instead of HTTPS. SSH uses RSA encryption which you can set up to be passwordless using
 public keys. There is a great tutorial by Github on how to set up and use this method [here](https://help.github.com/articles/generating-ssh-keys/).
 Note that you will need to add an SSH key for every different machine you want to clone on.

calc.py

@@ -19,22 +19,20 @@ def add(a, b):
 # a -- minuend
 # b -- subtrahend
 def sub(a, b):
-    # TODO -- implement subtraction here
-    return 0
+    return a - b
 
 # Multiply function
 # a -- multiplicand
 # b -- multiplier
 def mult(a, b):
-    # TODO -- implement multiplication here
-    return 0
+    return a * b
 
 # Divide function
 # a -- dividend
 # b -- divisor
 def div(a, b):
-    # TODO -- implement division here
-    return 0
+    return a / b
+
 
 # -------------------------------------------------------- #