[h0ffmann]

Requested by Hoffmann · project thread

what was asked

"the same" as legacy-CSUB#1:

1. revamp the README in the style of ww3-gpu, with a new logo
2. update the dependencies to the latest
3. add tests
4. use ASD-STE100
5. add an archive notice

what changed

• README.md: the layout of ww3-gpu's README, in ASD-STE100 Issue 9. The archive notice says this is a record of "Projeto Integrado 2017.1" at DEL/POLI/UFRJ, and that LIOC (COPPE/UFRJ) paid for the hardware.
• docs/logo.svg: an original drawing of a boat with an antenna and a GPS pin.
• Dependencies: gmailtotxt.py moves from Python 2 to Python 3, with pynmea2==1.19.0 (the latest on PyPI) in requirements.txt. The mailbox user and password now come from BT_MAIL_USER and BT_MAIL_PASSWORD. The script writes the same log line as the 2017 logs. The three PHP map pages read GOOGLE_MAPS_KEY from the environment.
• tests/test_repo.py and .github/workflows/tests.yml. The tests check the script against a 2017 log line, the e-mail body parsing, the log format, that no Maps key, phone number or written password is in the files, the PHP key from the environment, the archive notice, and that no README sentence is longer than 25 words. The secret patterns were checked against the unscrubbed history: they catch the key, the phones and the SMTP password.

proof

$ python3 -m unittest discover -s tests
Ran 10 tests in 0.018s
OK

facts and their sources

• Course, year and authors: the header of proj/embeddedsystem/src/emb.ino ("DEL/POLI/UFRJ, Projeto Integrado 2017.1").
• Funding, cost, hardware and the professors: doc/BoatTracker.tex.
• The last code commit: git log.
• The history was scrubbed before publishing: the mailbox password, the Maps key and three phone numbers are replaced, and the report PDFs and LaTeX build files are removed (the owner chose this, 12 November 2026).

what was not done or checked

• The embedded code is not updated or compiled. It is Energia .ino for the MSP432, and there is no toolchain or board here. NeoGPS (vendored 4.1.7) is not bumped.
• The vendored front-end pieces (siimple 2.0.1, the XAMPP dashboard) are not updated.
• The script was not run against a real mailbox. The PHP pages were not served.
• ASD-STE100 covers the README only. The tests check sentence length, not the dictionary. Comments, commits and the report stay in Portuguese.
• The report PDF is not rebuilt (no LaTeX here). The .tex source is in doc/.

---

Generated by Claude Code