Skip to content

Commit 9bade04

Browse files
author
Mario Bodemann
authored
Update README.md
1 parent 416c94b commit 9bade04

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

Diff for: README.md

+18-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Run script [hello](./hello) to generate 'hello my name is ...' badges.
44

5-
If an A6 thermo printer is attached, the `hello` script will print it.
5+
If an A6 thermo printer is attached, the `hello` script will print a badge, perfect for hackathons and meetups in general.
66

77
<img src="./attendee-badge.png" width="200"/>
88

@@ -12,14 +12,29 @@ Tested on Raspberry Pi 400, known to not working on MacOS (bluez not installable
1212

1313
# Usage
1414

15+
This script uses `chafa` for rendering the badge in ascii art on the command line and python's pygame / ppa6 to create and print the badge. Please install [chafa](https://github.com/hpjansson/chafa) anyway you like. And follow the [pyenv](#pyenv) steps to install the python dependencies.
16+
17+
:warning: This script is known to not work on MacOS, please use a Raspberry Pi :warning:
18+
19+
## pyenv
20+
21+
This script is written in python and it is recomeneded to use python venv. Activate it by using `python -m venv venv`. It creates a new folder `venv`. To activate that environment use `source venv/bin/activate`. Now that the environment is activated use `pip install -r requirements.txt` to install all dependencies.
22+
23+
Finally executing
24+
25+
1526
> ./hello
1627
28+
will start the badge creator.
29+
30+
In the welcoming menu, type `verbs` to find out what else to do:
1731

1832
`help`
1933

20-
`start`
2134

22-
The user comes to an attached screen, sees random images and is able to just print a badge, after entering a name and a number. The number references a predermined array of emoji or image pathes, and renderes them at the bottom center of the badge. This image / emoji is of great use for team building, and converstation starters.
35+
Use `start` to start the badge printing. A name of `exit` will exit the badge creation. Entering `exit` in the *main menu* will exit the main menu.
36+
37+
The user will get attracted by an attached screen, sees random images and is able to just print a badge, after entering a name and a number. The number references a predermined array of emoji or image pathes, and renderes them at the bottom center of the badge. This image / emoji is of great use for team building, and converstation starters.
2338

2439
Please feel free to read through the screen text to find out more what it can do.
2540

0 commit comments

Comments
 (0)