readme

README.md

@@ -1,37 +1,44 @@
-## Welcome to GitHub Pages
+# Path of Leveling
+**This is an alpha version, bugs included**
 
-You can use the [editor on GitHub](https://github.com/karakasis/-PC-POE-Path-of-Leveling/edit/master/README.md) to maintain and preview the content for your website in Markdown files.
+*Assisting program written on Java for [Path of Exile](https://www.pathofexile.com/game).*
 
-Whenever you commit to this repository, GitHub Pages will run [Jekyll](https://jekyllrb.com/) to rebuild the pages in your site, from the content in your Markdown files.
+*Get the [latest Version](https://github.com/karakasis/Path-of-Leveling/releases/tag/v0.4-alpha), updated December 28th 2018.*
 
-### Markdown
+## What does it do
 
-Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for
+This program currently does three things!
+- **Plan your leveling by selecting gems and links.** You can create complicated transitions between your gem setup, swap a gem for another one, or completely remove a Skill group for a different one. Get a popup on your in-game overlay when you reach certain levels.
+- **Navigate through the game's acts, with graphic representations from [Engineering Eternity](https://www.youtube.com/channel/UCaFHfrY-6uGSAvmczp_7a6Q/featured)** You can move the overlay around to suit your own needs. *Supporting only 1080p at this moment*
+- **Track your XP and find out when you are under/overleveled**. You can move the overlay around to suit your own needs. 
 
-```markdown
-Syntax highlighted code block
+## Launch
 
-# Header 1
-## Header 2
-### Header 3
+- Run PathOfLeveling.jar (Java 8 required) - *[download java](https://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html) jre-8u191-windows-x64.exe at the time of writting this*
+- Click the preferences gear button.
+- Select this file : Client.txt located within your Steam or Grinding Gear Games folder. 
 
-- Bulleted
-- List
+**C:\Program Files (x86)\Grinding Gear Games\Path of Exile\logs**
+- Save changes.
+- Decide which features you want to run. *If you want to use the leveling part, you have to create a build first at the editor and then select the build.*
+- Adjust your overlays in-game by drag and drop.
 
-1. Numbered
-2. List
+## How do I use the Editor?
+*Will be updating this with a better write-down*
 
-**Bold** and _Italic_ and `Code` text
+- Make sure to click Run > Validate and view leveling progress, to get a visual representation of your gem setup.
+- Make sure to click Run > Validate and return to Launcher, to return to Launcher (Humility panel) and select your build to continue.
 
-[Link](url) and ![Image](src)
-```
+## Known bugs
+*Will be updating this*
 
-For more details see [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/).
+## Support me
 
-### Jekyll Themes
+[![](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=XKQ7R4AWWVFR4)
 
-Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/karakasis/-PC-POE-Path-of-Leveling/settings). The name of this theme is saved in the Jekyll `_config.yml` configuration file.
-
-### Support or Contact
-
-Having trouble with Pages? Check out our [documentation](https://help.github.com/categories/github-pages-basics/) or [contact support](https://github.com/contact) and we’ll help you sort it out.
+*Some final words,*
+
+    I am a pre graduate Student of Computer Science and this project is far from being professional or completed.
+    As far as future update of this,I am planning to update the programm to keep up with the newest expansions. 
+    Im hoping to fix some major issues at February of 2019, when I will have some spare time.
+    If anyone is interested in helping, improving or anything on this project let me know!