Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: fix headers #29

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

README: fix headers #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#<a id="top"></a>Anonymouth
# <a id="top"></a>Anonymouth

![](src/edu/drexel/psal/resources/graphics/readme_Logo.png)

Expand All @@ -9,7 +9,7 @@ Drexel University, Philadelphia PA<br>
<http://psal.cs.drexel.edu/>


#Index
# Index
1. Set Up
- [Introduction](#introduction)
- [Dependencies](#dependencies)
Expand All @@ -24,9 +24,9 @@ Drexel University, Philadelphia PA<br>
- [Developers](#developers)
- [License](#license)

#Set Up
# 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.

Expand Down Expand Up @@ -106,7 +106,7 @@ Anonymouth also needs the following jars in the lib directory (everything should

[Back to top](#top)

###<a id="installation"></a>Installation
### <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>

Expand All @@ -116,19 +116,19 @@ This is currently the only ready way to compile and run Anonymouth. We will be i

[Back to top](#top)

###<a id="how-to-build-and-run"></a>How to Build and Run
### <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
# Development

###<a id="basic-logic-flow"></a>Basic Logic Flow
### <a id="basic-logic-flow"></a>Basic Logic Flow

#####↓ ---LAUNCH---
##### ↓ ---LAUNCH---


<b>Setup and start up:</b> `anonymouth.gooie.ThePresident`
Expand All @@ -140,19 +140,19 @@ Should never be accessed in any other class (or at least limit it). It's only pu
- Initializes the `GUIMain` instance (and with it all Anonymouth class instances)
- Displays the start window, which from there it takes over

#####↓ ---AUTOMATICALLY DISPLAYS---
##### ↓ ---AUTOMATICALLY DISPLAYS---

<b>Start up window:</b> `anonymouth.gooie.StartWindow`

The first window that shows up (not counting the splash screen) when Anonymouth loads up. Allows the user to change advanced processing settings, access the pre process set up wizard, or start Anonymouth

#####↓ ---USER CLICKED START BUTTON---
##### ↓ ---USER CLICKED START BUTTON---

<b>Initial document processing begins immediately with: </b>`anonymouth.engine.DocumentProcessor`

Inititalized within GUIMain as should nearly all Anonymouth class instances, this holds the main method and thread that handles processing and reprocessing documents. All processing events can be traced back to this class.

#####↓ ---PROCESSING COMPLETE---
##### ↓ ---PROCESSING COMPLETE---

<b>Main GUI Code:</b> `anonymouth.gooie.GUIMain`

Expand All @@ -171,9 +171,9 @@ The main gui window is displayed. This is also the central "hub" for Anonymouth.

[Back to top](#top)

###<a id="basic-class-structure"></a>Basic Class Structure
### <a id="basic-class-structure"></a>Basic Class Structure

#####---Naming Convention---
##### ---Naming Convention---

For the most part, Anonymouth splits UI objects into two classes: [Class name]Panel/Window and [Class name]Driver. By convention and a general guideline, the Panel/Window class:

Expand All @@ -189,7 +189,7 @@ While the cooresponding Driver class:

Again, these are just general guidelines. Sometimes it makes more sense to just have one class handle everything if it's a small object, or sometimes it doesn't make sense to have a seperate Panel/Window class but it does to have a Driver class, etc. You just need to use your best judgement on what will make things more organized and easier to understand.

#####---Package / Organizing Convention---
##### ---Package / Organizing Convention---

Anonymouth loosly follows these guidelines for class organization in packages:

Expand All @@ -202,7 +202,7 @@ There are still quite a few classes that are clearly where they don't belong, so

[Back to top](#top)

###<a id="to-do-list"></a>To Do List
### <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.
Expand All @@ -212,7 +212,7 @@ Add features as they are conceived and ~~strikethrough~~ as they are completed (

[Back to top](#top)

###<a id="known-bugs"></a>Known Bugs
### <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.
Expand All @@ -223,9 +223,9 @@ Add bugs as they are discovered and ~~strikethrough~~ as they are completed ([1]

[Back to top](#top)

#Credits
# Credits

###<a id="developers"></a>Developers
### <a id="developers"></a>Developers

P.I. Dr. Rachel Greenstadt:

Expand All @@ -242,7 +242,7 @@ Developed by:

[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>.

Expand Down