Skip to content

Commit

Permalink
Create README for LINUX examples
Browse files Browse the repository at this point in the history
  • Loading branch information
ImpulseAdventure authored Feb 8, 2018
1 parent a43d7f3 commit 14e9e69
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions linux/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# GUIslice library - Examples for LINUX #
This folder contains examples for LINUX-based devices using **SDL**
such as the **Raspberry Pi** or **Beaglebone Black**.

### Installation ###
In order to run the SDL1.2 / SDL2 examples, it is important that the SDL
graphics driver is installed first. A detailed installation guide has been
provided at: https://www.impulseadventure.com/elec/rpi-install-sdl.html

If touch support is required, then the **tslib** library should be
installed. A detailed installation guide has been provided at:
https://www.impulseadventure.com/elec/rpi-install-tslib.html

For the purposes of diagnostics, a simple test of the basic SDL graphics driver has been provided:

**SDL1.2**:
~~~
# Demonstration using SDL1.2
make test-sdl1
sudo ./test-sdl1
~~~

**SDL2**:
~~~
# Demonstration using SDL2
make test-sdl1
sudo ./test-sdl1
~~~

### Compiling ###
The examples in this folder are designed to be compiled using the provided `Makefile` at
the command-line. It is assumed that SDL and the optional touch library has been installed.
Detailed installation notes available at:

~~~
make gslc_07
sudo ./gslc_07
~~~


### Device Support ###
Sample code in these examples are intended for the following device platforms:
- Raspberry Pi 1 / 2 / 3
- Beaglebone Black
- and other LINUX platforms

### Resource Files ###
Some examples (eg. `glsc_ex03`) are intended to demonstrate image loading from SD cards.
In order to support these functions, one needs to ensure:
- Resource files from the `/res` folder are copied into the root of the SD card
- SD card support is enabled in `GUIslice_config_linux.h` (via `#define GSLC_SD_EN 1`)

0 comments on commit 14e9e69

Please sign in to comment.