#Cards Against Humanity ###"A Party Game for Horrible People" in Java ![Picture][CAHbox] [CAHbox]: https://github.com/PurpleKangaroo/Cards-Against-Humanity/blob/master/src/graphics/CAHbox.png?raw=true

Coming Out Summer 2014

We may be able to release this game earlier, but we hope to have the game out by the end of the school year so that High School Seniors with Senioritis may play it after they're done with the important stuff.

###PurpleKangaroo @PurpleKangaroo is a small organization of Lake Washington High School students who are interested in programing, many of whom are in the school's AP Computer Science class.

###How to Play Cards Against Humanity Cards Against Humanity Rules

###Documentation and Help Javadoc

Project Guidelines

Authors and Contributors

Holt Maki (@HoltMaki) - Lead Developer

Devon Grove (@devongrove) - Senior Developer, Lead Tester, Public Relations

Support or Contact

purplekangs@gmail.com ####Follow us on Twitter @PurpleKangs_Dev

#Project Guidelines ##General Guidelines: Use interfaces to stay organized.

Use whitespace where appropriate.

Use inner classes where appropriate.

Use good documentation. (See also: Javadoc Guidelines)

Creating a Jar File

##Creating a JAR File in Eclipse

1. File > Export
2. Java > Runnable JAR File
3. Next

   ![Picture][picture] [picture]: https://github.com/PurpleKangaroo/Cards-Against-Humanity/blob/master/Guidelines/jarImage.png?raw=true

4. Under "Library Handling:" select "Package required libraries into generated JAR.

##Javadoc Guidelines

• Add @depricated to (CAH#.#(.#)) to deprecated things. This makes it easy to go back later to find how the program used to work if we run into problems.

• Documentation for variables (only for instance variables):

    /**Brief Explanation*/ (preferably one line).
  

• Interface Documentation:

    /** Start with: "A collection of methods that ..."
     * Explanation....
     * @author(replace s-______ w/ your name; there can be multiple authors, just do @author on a new line.)
     * @version (CAH#.#(.#)) update version with new version
     * @since(CAH#.#(.#)) (don't change since after it has been finished)
     * (only if necessary) @see
     * @see DO NOT USE {@link} or {@linkplain} in see tags
     */
  

• Constructor Documentation:

    /**
     * "A class of object that represents ..."
     * Explanation....
     * @author(replace s-______ w/ your name; there can be multiple authors, just do @author on a new line.)
     * @since(CAH#.#(.#)) (don't change since after it has been finished)
     * (only if necessary) @param paramater [NO DASH] Explanation 
     * (only if necessary) @throws Throwable [NO DASH] Explanation 
     * (only if necessary) @see
     * @see DO NOT USE {@link} or {@linkplain} in see tags
     */
  

• Method documentation:

    /**
     * "_______" ... Explanation
     * @since(CAH#.#(.#))(dont change since after it has been finished)
     * (only if necessary) @param paramater [NO DASH] Explanation 
     * (only if necessary) @return returned - Explanation [There is a dash in this one]
     * (only if necessary) @throws Throwable [NO DASH] Explanation 
     * (only if necessary) @see
     * @see DO NOT USE {@link} or {@linkplain} in see tags
     */
  

• Enum documentation:

    /**
     * Explanation: "A list of ..."
     * @since (CAH#.#(.#))(dont change since after it has been finished)
     * @version (CAH#.#(.#)) update version with new version
     * (only if necessary) @see
     * @see DO NOT USE {@link} or {@linkplain} in see tags
     */
  

• Enumcontents documentation:

    /**
     * Explanation
     * @since (CAH#.#(.#))(dont change since after it has been finished)
     * (only if necessary) @see
     * @see DO NOT USE {@link} or {@linkplain} in see tags
     */