Skip to content

Commit 9e5fc65

Browse files
committed
2 parents aabaa5d + 738aa47 commit 9e5fc65

3 files changed

Lines changed: 27 additions & 2 deletions

File tree

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,16 @@ It also runs on Windows. This is especially helpful if you want to test a colori
77
## License
88
The license has been changed from MIT to GPL v3 on 2.5.2022. In general, I'm not a big fan of the GPL and rather prefer the more open MIT license.
99
However, in similar products open source software has been used to create close-source software that should replace existing open-source software.
10-
To make sure that won't happen with this software, the license of this software has been changed to GPL v3. Just to clarify: That doesn't mean
11-
anything about "commercial" or "non-commercial" use cases. If you want to create a commercial product based on this software, feel free to do so.
10+
To make sure that won't happen with this software, the license of this software has been changed to GPL v3.
11+
Just to clarify: That doesn't mean anything about "commercial" or "non-commercial" use cases. If you want to create a commercial product based
12+
on this software, feel free to do so.
1213
If you want to sell compiled versions of this software, you can do this as long as you provide users a way to access the full source code that's
1314
needed to build their own software. This is also valid for any derivate work.
1415

16+
## Donations
17+
18+
If you like this, feel free to send a donation. However, not to us, but to a charity of your choice. You don't have to send us any money to use this software.
19+
1520
## Documentation
1621

1722
- [Installation](doc/install.md)

doc/colorisations.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,5 @@ The following colorisations have been tested. Others might also work. If you tes
33
|Name & Version|Type|Status|tested by|Date|Comments|
44
|---|---|---|---|---|---|
55
|[Tron 2.2](https://vpuniverse.com/files/file/14216-tron-legacy-stern-2011-dmd-64-colors-serum-format-v22-final)|Serum|ok|[pinballpower](https://github.com/pinballpower)|30.6.23|works great|
6+
7+
If you like a colorisation, you might send a donation to the author of the colorisation.

doc/development.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Development tips & tricks
2+
3+
## Platform
4+
5+
It's often best to develop on a modern PC instead of a Raspberry Pi. DMDReader has been developed mostly on Windows. Compilation is a lot faster on a PC than on a Raspberry Pi.
6+
7+
## Memory
8+
9+
Note that DMDReader uses some C++ frameworks. Modern C++ frameworks use a lot of templates. The good thing about this: You can write very clean code that is also very fast.
10+
The bad thing: the compiler has a lot of work to do to deal with all these templates. This means on a slow system it will take some time to compile it. You also need a lot of
11+
memory. Use a system with at least 2GB of RAM. If you run muliple jobs in parallel, have at least 2GB RAM physical RAM per job.
12+
13+
## Timing
14+
15+
A real pinball machine delievers DMD frames at a fixed rate - independent if something has been changed or not. DMDReader (and even the RP2040 hardware interface for real pinballs)
16+
deduplicate frames. By default, a frame is only being processed if something has changes. This can create problems with some processors (e.g. the VNI module) - that expect frames at
17+
a fixed rate.
18+
There are some workarounds to deal with this:

0 commit comments

Comments
 (0)