Add README and TUTORIAL

README.md

@@ -0,0 +1,125 @@
+<div id="top"></div>
+
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  <a href="https://github.com/victorrjimenezz/4PT-Repository">
+    <img src="Resources/icon.png" alt="Logo" width="80" height="80">
+  </a>
+
+<h3 align="center">4PT Repository GUI</h3>
+
+  <p align="center">
+    A GUI to create 4PT Repositories
+    <br />
+    <a href="https://github.com/victorrjimenezz/4PT-Repository/issues"><strong>Request Feature / Report Bug</strong></a>
+    <br />
+    <br />
+    <a href="https://www.4pt-project.com">Website</a>
+    .
+    <a href="https://github.com/victorrjimenezz/PS4-4PT">The 4PT APP</a>
+    ·
+    <a href="https://github.com/victorrjimenezz/4PT-Repository">4PT Template Repository</a>
+    ·
+    <a href="https://github.com/victorrjimenezz/4PT-REPO-GUI/blob/master/TUTORIAL.md">GUI tutorial</a>
+  </p>
+</div>
+
+
+
+
+<!-- TABLE OF CONTENTS -->
+<details open>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li>
+        <a href="#ata">About The Tool</a>
+      <ul>
+        <li><a href="#ss">Screenshots</a></li>
+      </ul>
+    </li>
+    <li><a href="#feat">Features</a></li>
+    <li><a href="#usage">Usage</a></li>
+    <li>
+      <a href="#todo">TODO</a>
+    </li>
+    <li><a href="#buildDep">Build Dependencies</a></li>
+    <li><a href="#developers">Developers</a></li>
+  </ol>
+</details>
+
+***
+
+<div id="ata"></div>
+
+## About The GUI
+
+This is a Graphical User Interface to make it easier for 4PT users to create their own repository. </br>
+This allow users to avoid the need to modify YML files, and makes creating a repository as easy as dropping the pkgs and selecting the type. </br>
+The GUI also features a mini HTTP server that allows users to host a repository without the need of a hosting service or an APACHE server.
+
+<div id="ss"></div>
+
+
+### Screenshot
+
+
+<p float="left">
+  <img src="screenshots/screenshotDefault.png" width="100%"  alt=""/>
+</p>
+
+***
+
+<div id="feat"></div>
+
+## Features
+
+The current working app features are:
+
+- Adding/Deleting pkgs and changing their types
+- Export the repository to a folder or a ZIP file
+- Host the repository without the need of an APACHE server or a hosting service
+
+***
+
+<div id="usage"></div>
+
+## Usage
+
+_For information on how to use the GUI, refer to [Tutorial](https://github.com/victorrjimenezz/4PT-REPO-GUI/blob/master/TUTORIAL.md)_
+
+_For information on repositories, please refer to  [4PT-Repository](https://github.com/victorrjimenezz/4PT-Repository)_
+
+_For information on 4PT, please refer to  [4PT](https://github.com/victorrjimenezz/PS4-4PT)_
+
+***
+
+<div id="todo"></div>
+
+## TODO
+
+- [ ] Drag and drop repository icon
+- [ ] Add task bar icon on windows
+- [ ] Edit existing repositories
+- [ ] Add Linux support
+
+See the [open issues](https://github.com/victorrjimenezz/PS4-4PT/issues) for a full list of proposed features (and known issues).
+
+***
+
+<div id="buildDep"></div>
+
+## Build Dependencies
+
+This project is built using the Open Orbis PS4 Toolchain and the Yaml-CPP library.
+
+* [Zip](https://github.com/kuba--/zip)
+* [Yaml-CPP](https://github.com/jbeder/yaml-cpp)
+
+***
+
+<div id="developers"></div>
+
+## Developers
+
+Víctor Jiménez - [@victorrjimenezz](https://twitter.com/victorrjimenezz) - [victorjimenez@4pt-project.com](mailto:victorjimenez@4pt-project.com)

TUTORIAL.md

@@ -0,0 +1,112 @@
+<div id="top"></div>
+
+<!-- PROJECT LOGO -->
+<br />
+
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  <a href="https://github.com/victorrjimenezz/4PT-Repository">
+    <img src="Resources/icon.png" alt="Logo" width="80" height="80">
+  </a>
+
+<h3 align="center">4PT Repository GUI</h3>
+
+  <p align="center">
+    A GUI to create 4PT Repositories
+    <br />
+    <a href="https://github.com/victorrjimenezz/4PT-Repository/issues"><strong>Request Feature / Report Bug</strong></a>
+    <br />
+    <br />
+    <a href="https://www.4pt-project.com">Website</a>
+    .
+    <a href="https://github.com/victorrjimenezz/PS4-4PT">The 4PT APP</a>
+    ·
+    <a href="https://github.com/victorrjimenezz/4PT-Repository">4PT Template Repository</a>
+  </p>
+</div>
+
+
+
+<!-- TABLE OF CONTENTS -->
+<details open>
+  <summary>Table of Contents</summary>
+  <ol>
+   <li><a href="#rn">Changing the repository name</a></li>
+   <li><a href="#ri">Changing the repository icon</a></li>
+   <li><a href="#ap">Adding Packages</a></li>
+   <li><a href="#rp">Removing Packages</a></li>
+   <li><a href="#hr">Hosting a Repository</a></li>
+   <li><a href="#er">Exporting the repository</a></li>
+  </ol>
+</details>
+
+***
+
+<div id="rn"></div>
+
+## Changing the repository name
+
+<p float="left">
+  <img src="screenshots/screenshotDefault.png" width="100%"  alt=""/>
+</p>
+
+To change the repository name, set the text on the upper-left side of the app to
+the desired name
+
+***
+
+<div id="ri"></div>
+
+## Changing the repository icon
+
+To change the repository icon, click the `Select Repo Icon` button and
+select the desired icon from the computer.
+
+***
+
+<div id="ap"></div>
+
+## Adding packages
+
+To add packages, you can drag and drop them to the pkg list box, or add them manually by
+clicking the `Add PKGs` button.
+
+To add an entire folder full of PKGs, simply drag and drop it to the pkg list box, or add it manually
+by clicking the `Add Folder` button. **NOTE: THIS WILL SEARCH RECURSIVELY INSIDE FOLDERS, SO IF THERE ARE SUBFOLDERS
+FULL OF PACKAGES, THOSE PACKAGES WILL ALSO BE ADDED**
+
+***
+
+<div id="rp"></div>
+
+## Removing packages
+
+To remove a package, select it from the PKG list box, and click the del button of the keyboard, or press the remove PKG button
+
+***
+
+<div id="hr"></div>
+
+## Hosting a repository
+
+<p float="left">
+  <img src="screenshots/screenshotServer.png" width="100%"  alt=""/>
+</p>
+
+To host a repository, first set it up as you wish following the previous instructions, then 
+press the `Start Server` button. To stop it, press the `Stop Server` button.
+
+***NOTE: When the server has started, the start button should switch to the stop button and
+the text field next to it should say Server Running on IP:PORT. Otherwise, the server
+initialization has failed and will display the message: Could not start server on IP:PORT***
+
+***
+
+<div id="hr"></div>
+
+## Exporting a repository
+
+To export a repository, press the export to folder or export to zip button, and select the destination.
+
+**NOTE: This will copy the PKGs to the destination folder or the zip file**