updated

Author: shehan

README.md

@@ -1,12 +1,23 @@
-# Project Sunshine
-_[working name]_
-
-This project is related to the identifier rename tool.
-
-- ## Anti-Pattern Rules
-    - ### [Arnaoudova et al.](http://veneraarnaoudova.com/wp-content/uploads/2014/10/2014-EMSE-Arnaodova-et-al-Perception-LAs.pdf)
-    - ### [SCANL](documentaion/AntiPatternRules_SCANL.md)
-    
-- ## Implementation Status
-    - ### [Arnaoudova et al.](documentaion/AntiPatternStatus_Arnaoudova.md)
-    - ### [SCANL](documentaion/AntiPatternStatus_SCANL.md)
+# IDEAL
+
+#### _An Open-Source Identifier Name Appraisal Tool_
+
+### Abstract
+
+Developers must comprehend the code they will maintain, meaning that the code must be legible and reasonably
+self-descriptive. Unfortunately, there is still a lack of research and tooling that supports developers in understanding
+their naming practices; whether the names they choose make sense, whether they are consistent, and whether they convey
+the information required of them. In this paper, we present IDEAL, a tool that will provide feedback to developers about
+their identifier naming practices. Among its planned features, it will support linguistic anti-pattern detection, which
+is what will be discussed in this paper. IDEAL is designed to, and will, be extended to cover further anti-patterns,
+naming structures, and practices in the near future. IDEAL is open-source and publicly available, with a demo video
+available at: [https://youtu.be/fVoOYGe50zg](https://youtu.be/fVoOYGe50zg)
+
+### Setup and Use
+
+Details around setting up and using IDEAL are available [here](documentaion/SetupAndUse.md).
+
+
+### Naming Violations
+- ### [Arnaoudova et al.](documentaion/AntiPatternRules_Arnaoudova.md)
+- ### [SCANL](documentaion/AntiPatternRules_SCANL.md)

documentaion/SetupAndUse.md

@@ -69,3 +69,6 @@ C. [Configure and Run IDEAL For Project](#Configure-and-Run-IDEAL-For-Project)
 5. Results saved in IDEAL_Results.csv file
 
    <img src="images\setup\results.png"  style="zoom:40%;" />
+
+
+##### [Back To ReadMe](../README.md)

documentaion/ToolDetails.md

@@ -33,10 +33,10 @@ This document provides details (functional and technical) around our linguistic
   - Part-of-Speech tagging - Stanford tagger (4.2.0)
 
 
-
-
-
 ## References
 
 [1] Arnaoudova, V., Di Penta, M., & Antoniol, G. (2016). Linguistic antipatterns: What they are and how developers
 perceive them. Empirical Software Engineering, 21(1), 104-158.
+
+
+##### [Back To ReadMe](../README.md)