add info to README
parent
4125ea1dd4
commit
f8fa33acc6
@ -1,17 +1,35 @@
|
|||||||
# Pi-Apps 
|
# Pi-Apps 
|
||||||
## Raspberry Pi App Store for Open Source Projects
|
## Raspberry Pi App Store for Open Source Projects
|
||||||
|
|
||||||
There are many open-source, community-developed software projects for Raspberry Pi, yet very few people know about them. Pi-Apps aims to improve that, functioning as a software catalog and standardizing installation.
|
There are many open-source, community-developed software projects for Raspberry Pi, yet very few people know about them. Pi-Apps aims to improve that, functioning as a software catalog and standardizing installation.
|
||||||
|
|
||||||
**Please note that Pi-Apps is very new and is a work in progress.** Keep that in mind if you encounter an error.
|
**Pi-Apps is very new and is a work in progress.** Please [report](https://github.com/Botspot/pi-apps/issues/new) any errors you encounter.
|
||||||
|
|
||||||
### To install Pi Apps:
|
### To install Pi Apps
|
||||||
```
|
```
|
||||||
git clone https://github.com/Botspot/pi-apps
|
git clone https://github.com/Botspot/pi-apps
|
||||||
/home/pi/pi-apps/install
|
/home/pi/pi-apps/install
|
||||||
```
|
```
|
||||||
The install script ensures YAD is installed and creates a menu button. Nothing is modified outside your home directory.
|
The install script ensures YAD is installed and creates a menu button. Nothing is modified outside your home directory.
|
||||||
### To run Pi Apps:
|
### To run Pi Apps
|
||||||
Menu -> Accessories -> Pi Apps, or type `./pi-apps/gui`.
|
Menu -> Accessories -> Pi Apps, or type `./pi-apps/gui`.
|
||||||
|
### Basic usage
|
||||||
|
- This is the **main window**:
|
||||||
|

|
||||||
|
Use the main window to quickly browse the selection of apps and easily install them.
|
||||||
|
- If you double-click an app, or select and app and click Details, you will see the **Details window**.
|
||||||
|

|
||||||
|
- The **updater window** may pop up when you launch Pi-Apps:
|
||||||
|

|
||||||
|
Unless you have a very good reason not to, clicking 'Update now' is strongly recommended.
|
||||||
|
- Pi-Apps **Settings** can be configured by launching Menu -> Preferences -> Pi-Apps Settings.
|
||||||
|

|
||||||
|
- If you click **New App** in Settings, you can easily create your own Apps with a wizard-style sequence of windows.
|
||||||
|

|
||||||
|
It helps you select an icon, create & debug install/uninstall scripts, write a description, and more.
|
||||||
|
### How it works
|
||||||
|
- Each 'App' is simply a small `install` script, `uninstall` script, two icon sizes, and two text files containing the description and a website URL.
|
||||||
|
- Each App is stored in its own separate directory. `/home/pi/pi-apps/apps/` holds all these app directories. The Zoom app, for example, would be located at `/home/pi/pi-apps/apps/Zoom/`.
|
||||||
|
- Because of the contained nature of each app folder, it's really easy to 'package' your own apps: just put the folder in a ZIP file and send it to friends. (or upload it as a [new issue](https://github.com/Botspot/pi-apps/issues/new) so your app can be added to Pi-Apps)
|
||||||
|
- When you click Install, the selected App's install script is executed.
|
||||||
|
- When you click Uninstall, the selected App's uninstall script is executed.
|
||||||
|
Loading…
Reference in New Issue