README for desktop

README.md

@@ -1 +1,34 @@
-# Peppubuild App
+# Peppubuild App
+
+This page holds all information that is needed to setup a desktop application that runs Peppubuild in yur local environment. The goal is to build a self-hosted version of peppubuild that you can use anywhere. We use Google Firebase for authentication so you can access your account anywhere. You can also setup your Github account to store your codes so that they are not lost.
+
+## How to Sync with Github
+
+Peppubuild doesn't collect or store your personal information. You will notice this if you use Vision AI since you need to add your API keys at the begining of each session. While each project contains a `.peppubuild` file that stores snippet of your project so that they can be loaded successfully with Peppubuild, we don't want you to loose your project if you don't have access to your PC. For this, you can store your project on Github so that it is easily accessible from anywhere. Follow the steps below.
+
+- 
+
+We are working on incorporating other Git hosting platflorms.
+
+## Instructions
+
+First, download the version that suits your [system's operating system](). Now, follow the instruction for the operating system package you installed.
+
+### Windows
+
+After downloading the `.exe` package, double click it to start.
+
+### Mac
+After downloading the `.dmg` package, double click the `.dmg` file and drag the Peppubuild icon to the Application folder.
+
+Next, right-click the Peppubuild application and "the risk" in the security pop-up in-order to run the application for the first time.
+
+### Linux
+After downloading the `.AppImage` package, Right click on the downloaded file and chose **Properties -> Permissions -> Allow executing file as program**. Or, you can run the command below in your terminal.
+
+```bash
+// where filename is the name of the downloaded file.
+chmod +x filename
+```
+
+The command above will do the same thing as the setting; making the file an executable (application).