Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
instruction fixes
  • Loading branch information
aaronelmore authored Jan 5, 2017
1 parent 42637ce commit f352f50
Showing 1 changed file with 24 additions and 17 deletions.
41 changes: 24 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,33 +16,30 @@ These concepts will be necessary for the lab assignments.

## Things to do

You will need to edit HW0Runner and implement an implementation of the Containers interface.
Make sure you have git, a Java 1.7+ JDK, and ant installed and running on your machine.

You will need to edit HW0Runner and create an implementation class of the Containers interface.

Start by forking the hw0 repo and downloading the code for hw0 from the course GitHub.

### Interfaces
If you have never worked with interfaces see:
https://www.tutorialspoint.com/java/java_interfaces.htm

### IDE
We have included [a section](#eclipse) on using the project with Eclipse.


Start by cloning the hw0 repo and downloading the code for hw0 from the course GitHub
## To Submit

See the Piazza HW0 post for the due date and instructions and submission form.

## Running Tests

SimpleDB and HW0 uses the [Ant build tool](http://ant.apache.org/) to compile the code and run tests.
Ant is similar to [make](http://www.gnu.org/software/make/manual/), but
the build file is written in XML and is somewhat better suited to Java code.
Most modern Linux distributions include Ant. Under Athena,
it is included in the `sipb` locker, which you can
get to by typing `add sipb` at the Athena prompt. Note that
on some versions of Athena you must also run `add -f java` to set
the environment correctly for Java programs. See the
[Athena documentation
on using Java](http://web.mit.edu/acs/www/languages.html#Java) for more details.

To help you during development, we have provided a set of unit tests in
addition to the end-to-end tests that we use for grading. These are by no means
comprehensive, and you should not rely on them exclusively to verify the
correctness of your project (put those 6.170 skills to use!).
Most modern Linux distributions include Ant.

To run the unit tests use the `test` build target:

Expand Down Expand Up @@ -100,11 +97,20 @@ by copying from build.xml, modifying targets and arguments and renaming it to, s

[Eclipse](http://www.eclipse.org) is a graphical software
development environment that you might be more comfortable with working in.
The instructions we provide were generated by using Eclipse 3.5.2 (Galileo)
The instructions we provide were generated by using Eclipse
for Java Developers (not the enterprise edition) with Java 1.6.0_20 on Ubuntu
10.04 LTS. They should also work under Windows or on MacOS.
14.04 LTS. They should also work under Windows or on MacOS.

**Setting the Lab Up in Eclipse**

**Set Up for Eclipse**
* git clone your repository
* Run ```ant eclipse``` in the project directory (make sure you get no errors here)
* Install and run Eclipse
* File -> Import -> Projects From Git -> Local -> Then add the directory where you cloned your forked repo -> Finish
* Next-> Import Existing Project
* Click finish, and you should be able to see "uchidbhw0" as a new project in the Project Explorer tab on the left-hand side of your screen. Opening this project reveals the directory structure discussed above - implementation code can be found in "src," and unit tests and system tests found in "test."

**Alternative Setting the Lab Up in Eclipse**

* Once Eclipse is installed, start it, and note that the first screen asks you to select a location for your workspace (we will refer to this directory as $W). Select the directory containing your hw0 repository.
* In Eclipse, select File->New->Project->Java->Java Project, and push Next.
Expand All @@ -114,6 +120,7 @@ for Java Developers (not the enterprise edition) with Java 1.6.0_20 on Ubuntu

**Note:** that this class assumes that you are using the official Oracle release of Java. This is the default on MacOS X, and for most Windows Eclipse installs; but many Linux distributions default to alternate Java runtimes (like OpenJDK). Please download the latest Java6 updates from [Oracle Website](http://www.oracle.com/technetwork/java/javase/downloads/index.html), and use that Java version. If you don't switch, you may see spurious test failures in some of the performance tests in later labs.


**Running Individual Unit and System Tests**

To run a unit test or system test (both are JUnit tests, and can be
Expand Down

0 comments on commit f352f50

Please sign in to comment.