Skip to content

Commit

Permalink
Add installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
RossAdrian committed Jul 28, 2024
1 parent 38504e0 commit 8f79bdc
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#!/usr/bin/env python3
from setuptools import setup, Extension
import platform

Expand Down

0 comments on commit 8f79bdc

Please sign in to comment.