-Slight layout modifications to readme file

README.md

@@ -1,4 +1,4 @@
-#Anonymouth
+#<a id="top"></a>Anonymouth
 
 ![](src/edu/drexel/psal/resources/graphics/Readme_logo.png)
 
@@ -11,30 +11,32 @@ Drexel University, Philadelphia PA<br>
 
 #Index
 1. Set Up
-	- [Introduction](#Introduction)
-	- [Dependencies](#Dependencies)
-	- [Installation](#Installation)
-	- [How to Build and Run](#HowtoBuildandRun)
+	- [Introduction](#introduction)
+	- [Dependencies](#dependencies)
+	- [Installation](#installation)
+	- [How to Build and Run](#how-to-build-and-run)
 2. Development	
-	- [Basic Logic Flow](#BasicLogicFlow)
-	- [Basic Class Strucutre](#BasicClassStructure)
-	- [To Do List](#ToDoList)
-	- [Known Bugs](#KnownBugs)
+	- [Basic Logic Flow](#basic-logic-flow)
+	- [Basic Class Strucutre](#basic-class-structure)
+	- [To Do List](#to-do-list)
+	- [Known Bugs](#known-bugs)
 3. Credits
-	- [Developers](#Developers)
-	- [License](#License)
+	- [Developers](#developers)
+	- [License](#license)
 
 #Set Up
 
-###<a id="Introduction"></a>Introduction
+###<a id="introduction"></a>Introduction
 
 Anonymouth is a Java-based application that aims to give users to tools and knowledge needed to begin anonymizing documents they have written.
 
 It does this by firing up JStylo libraries (an author detection application also develped by PSAL) to detect stylometric patterns and determine features (like word length, bigrams, trigrams, etc.) that the user should remove/add to help obsure their style and identity.
 
 Though Anonymouth and it's team works hard to provide you with tools to help remove your identity from documents you have written, WE CAN IN NO WAY GUARANTEE THAT YOUR DOCUMENT IS ANONYMOUS OR NOT ANONYMOUS. Anonymouth is always giving you it's best guess, it's best idea of where your document stands, though that should not any any time be taken as an absolute (for example, you could have forgotten to remove your name from the document and Anonymouth has no way to know that that's your name and should remove it). What we can say is Anonymouth is only as good as you make it, and when used right can be helpful in guiding your document towards the right direction.
 
-###<a id="Dependencies"></a>Dependencies
+[Back to top](#top)
+
+###<a id="dependencies"></a>Dependencies
 
 Java 7 is required to run Anonymouth. If you don't yet have it, get it at <a href="http://java.com/en/download/index.jsp">Oracle's website here</a> and follow the installation instructions provided there.
 
@@ -102,23 +104,29 @@ Anonymouth also needs the following jars in the lib directory (everything should
   </tr>
 </table>
 
-###<a id="Installation"></a>Installation
+[Back to top](#top)
+
+###<a id="installation"></a>Installation
 
 There quickest and easiest way to install Anonymouth is to clone or download the zip of the <a href="https://github.com/psal/anonymouth">Anonymouth github project here</a>
 
 And then import this project as an existing project into Eclipse (or clone and import directly within Eclipse if you have the Eclipse eGit plugin).
 
 This is currently the only ready way to compile and run Anonymouth. We will be including a updated build file soon so that you may build and run Anonymouth easily within the command land, but sadly it hasn't been done yet so this is the only option currently
 
-###<a id="HowtoBuildandRun"></a>How to Build and Run
+[Back to top](#top)
+
+###<a id="how-to-build-and-run"></a>How to Build and Run
 
 Once Anonymouth is all set up in Eclipse, you need only run `ThePresident` from the package `edu.drexel.psal.anonymouth.gooie` to begin using it.
 
 Please note that there are two main package categories, JStylo and Anonymouth. The majority of Anonymouth developement should be in the Anonymouth packages as Anonymouth simply uses the JStylo libraries for parts of the initial document process, so beginners need only concern themselves with the Anonymouth packages.
 
+[Back to top](#top)
+
 #Development
 
-###<a id="BasicLogicFlow"></a>Basic Logic Flow
+###<a id="basic-logic-flow"></a>Basic Logic Flow
 
 #####↓ ---LAUNCH---
 
@@ -161,7 +169,9 @@ The main gui window is displayed. This is also the central "hub" for Anonymouth.
 - If they are changing Preferences, the main class handling that is `anonymouth.gooie.PreferencesWindow`
 - etc.
 
-###<a id="BasicClassStructure"></a>Basic Class Structure
+[Back to top](#top)
+
+###<a id="basic-class-structure"></a>Basic Class Structure
 
 #####---Naming Convention---
 
@@ -190,15 +200,19 @@ Anonymouth loosly follows these guidelines for class organization in packages:
 
 There are still quite a few classes that are clearly where they don't belong, so feel free to oragnize Anonymouth so that it best fits these guidelines.
 
-###<a id="ToDoList"></a>To Do List
+[Back to top](#top)
+
+###<a id="to-do-list"></a>To Do List
 Add features as they are conceived and ~~strikethrough~~ as they are completed ([1] means most important and [5] means relatively small and not particularly a priority at the moment)
 
 - [1] AUTOMATE AS MUCH OF THE ANONYMIZATION PROCESS AS POSSIBLE. This should be the top priority as of now, see Andrew for the plan and details.
 - [1] An internal  thesaurus must be implemented to help users change words to remove (that or nicely implement the one built into the system, preferable if possible)
 - [2] An intelligent method to search and filter through words to add (start with simple search box, then possibly extend to automatic filtering based on synonyms?)
 - [5] The clusters window should be updated to be easier to understand and use (it's hidden away in `Window > Clusters`)
 
-###<a id="KnownBugs"></a>Known Bugs
+[Back to top](#top)
+
+###<a id="known-bugs"></a>Known Bugs
 Add bugs as they are discovered and ~~strikethrough~~ as they are completed ([1] means fatal or breaks usability and [5] means relatively small and does not have much of an impact on usability)
 
 - [1] During processing on OS X (though the problem may extend to other operating systems as well) the Stanford POS tagger is extremely prone to breaking due to a fatal threading issue which results in heap space or out of memory exceptions. This absolutely MUST be fixed.
@@ -207,9 +221,11 @@ Add bugs as they are discovered and ~~strikethrough~~ as they are completed ([1]
 - [5] The max features slider in Preferences does not work as expected at times and is a little finicky.
 - [5] Currently Anonymouth is all running on the initial thread which <a href="http://docs.oracle.com/javase/tutorial/uiswing/concurrency/initial.html">should NOT be the case</a>. This should be done in a GUI creation and show task thread, though when I tried this in the past it breaks the slash screen.
 
+[Back to top](#top)
+
 #Credits
 
-###<a id="Developers"></a>Developers
+###<a id="developers"></a>Developers
 
 P.I. Dr. Rachel Greenstadt:
 
@@ -223,7 +239,11 @@ Developed by:
   	- Forward questions or concerns pertaining to Anonymouth's UI or front end/editor to <meb388@drexel.edu>
   - Jeff Ulman
   - Joe Muoio
+
+[Back to top](#top)
+
+###<a id="license"></a>License
 
-###<a id="License"></a>License
+Anonymouth was released by the Privacy, Security and Automation lab at Drexel University in 2011 under the AGPLv3 license. A copy of this license is included with the repository/program. If for some reason it is absent, it can be viewed <a href="http://www.gnu.org/licenses/agpl.html">here</a>.
 
-Anonymouth was released by the Privacy, Security and Automation lab at Drexel University in 2011 under the AGPLv3 license. A copy of this license is included with the repository/program. If for some reason it is absent, it can be viewed <a href="http://www.gnu.org/licenses/agpl.html">here</a>.
+[Back to top](#top)