From 8f79bdce8bde6cc9b093ebe7c16670ecde84a31c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adrian=20Ro=C3=9F?= Date: Sun, 28 Jul 2024 18:02:10 +0000 Subject: [PATCH] Add installation instructions --- README.md | 13 +++++++++++++ setup.py | 1 + 2 files changed, 14 insertions(+) diff --git a/README.md b/README.md index 17a463b..14b0397 100644 --- a/README.md +++ b/README.md @@ -12,3 +12,16 @@ The library has been tested on the *Raspberry Pi 4 Model B*. Other hardware devi Other hardware then the *Raspberry Pi 4* may be supported. But testing the framebuffer access on x86_64 computers and Qemu were not successful. +## Installation + +Download the sources from [GitHub](https://github.com/RossAdrian/pyframebuffer) and run the following commands: + +```sh +sudo ./setup.py install +``` + +Ensure you have installed the python development package (named `python-dev` or `python-devel`) of your Linux distribution +to be able to build and install this package. Recommended is the installation on a headless distribution with framebuffer +console like *Raspberry Pi OS lite* or *Ubuntu Server* to see the graphics output on the screen. Full screen display without +noisy framebuffer console output is best with running a python script with the draw operations and sleep the amount of seconds +required to see the magic of the graphics output. \ No newline at end of file diff --git a/setup.py b/setup.py index 13b4a6e..d23b5a2 100644 --- a/setup.py +++ b/setup.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python3 from setuptools import setup, Extension import platform