Jak dodać informację na gicie dot. skompilowania + uruchomienia kodu?

Cześć,

Natrafiłem na taki oto tekst:

"Przesłane rozwiązanie powinno zawierać:
-repozytorium kodu z rozwiązaniem (jako archiwum .zip)
-dostarczone materiały, oprócz przesłanego kodu źródłowego powinny zawierać również informację jak skompilować / zbudować dostarczone
źródła i sposób uruchomienia kodu"

No więc nie bardzo rozumiem do końca jakbym miał wykonać ten drugi punkt. Wprawdzie kiedyś spotkałem się już na profilach ludzi na gicie, że mają podpunkt: setup/budowa itp. i mieli to wypunktowane( jakieś komendy itp) jednak nie mogę/nie wiem jak szukać czegoś znaleźć co mi pomoże. Załóżmy, że mam api które ma jakiś tam endpoint np. /hello który mi zwraca napis "hello world", do tego korzystam z no nie wiem, np z bazy która mi przechowuje ten napis i oauth który zabezpiecza mi przed wejściem bez weryfikacji na ten enpoint. Jakby to miało wyglądać od początku do końca?
Dodam tylko, że nie staram się nigdzie dostać do pracy/staż ( jeszcze :D ) a tylko uzupełnić swojego gita o takie treści.

Jak zbudować itp. - dodajesz plik README.md z listą instrukcji, np. u mnie https://github.com/marcin-chwedczuk/javafx-validation

Baza danych - schemat powinien zostać stworzony przy pierwszym podłączeniu się aplikacji. Bazę można "napchać" testowymi danymi Hibernate wspiera ten scenariusz (https://www.baeldung.com/spring-boot-data-sql-and-schema-sql)

Kiedyś (dawno dawno temu) aplikowałem do Pragmatists i napisałem coś takiego: https://github.com/marcin-chwedczuk/tmp-checkout
Generalnie nie spodobało im się (a może to ze chciałem wtedy 13k h** wie??? - jeszcze czuję do nich urazę po tej stracie czasu), ale projekt pozostał na moim GitHubie.

W dobrym stylu byłoby teraz użyć Docker Compose tak żeby postawić jednym poleceniem kontener z bazą danych i drugi z aplikacją i połączyć je siecią.
Aplikacja jak wstanie to stworzy schemat bazy danych i napcha ją przykładowymi danymi.
Hasło może być brane jakieś domyśle admin/1234. Nikt nie powinien się do tego przyczepić.

Najlepiej to szukaj na GitHubie działających projektów i kopiuj stamtąd pomysł, tak będzie najszybcie. Te "projekty domowe" to kompletne marnowanie czasu.