diff --git a/src/makefile/README.md b/src/makefile/README.md index bc9063bf7f1700c85e89c78fadf703f5038eccf0..5513ee992e1e9a0bf51e117234d92edbb932b107 100644 --- a/src/makefile/README.md +++ b/src/makefile/README.md @@ -170,7 +170,8 @@ Der Aufruf von `make download` speichert diese Dateien im zuvor definierten Ordn ## Konfiguration > [!important] -> Die Anpassung der in der _Makefile_ mit `# todo` gekennzeichneten Konfigurationsvariablen ist zwingend erforderlich, um eine korrekte Ausführung sicherzustellen. +> Die Anpassung der in der _Makefile_ mit `#TODO` gekennzeichneten Konfigurationsvariablen ist zwingend erforderlich, um eine korrekte Ausführung sicherzustellen. +> Die `#TODO`-Tags müssen außerdem unbedingt entfernt werden, bevor die _Makefile_ verwendet werden kann; mögliche Leerzeichen führen sonst zu Problemen. ### Server @@ -286,7 +287,7 @@ Also bspw. `~/akis/my_project` oder `/home/mmustermann/akis/my_project`. #### `MAIN_SCRIPT` -> ... definiert das _Python_-Script, welches die _Makefile_ auf dem Server ausführt.s +> ... definiert das _Python_-Script, welches die _Makefile_ auf dem Server ausführt. In Projekten mit nur einem Python-Script beinhaltet dieses Script den gesamten Code. In Projekten mit mehreren Python-Scripts führt das `MAIN_SCRIPT` meist weitere Python-Scripts aus. @@ -391,15 +392,31 @@ Für diesen Fall ist `COPY_LINKS_AS_FILES` auf `true` zu setzen. ## TODOs -- [x] Bedienung über _Byobu_ -- [ ] Datasets über NFS -- [ ] Benachrichtigung bei Abbruch/Erfolg +### Documentation + +- [x] docs(makefile): add byobu installation + - [ ] docs(makefile): add byobu shortcuts +- [ ] docs(makefile): get local python packages; append to `PYTHON_PACKAGES` + +### Fixes + +- [ ] fix(makefile): `source` Mamba +- [x] fix(makefile): support download file wildcards + - `REMOTE_DOWNLOAD_FILES := *.pdf *.png` +- [ ] feat(makefile): pypi package support + +### Features + +- [ ] feat(makefile): add status notification - [ ] Slack - [ ] E-Mail - [ ] Matrix -- [ ] parallele Ausführung mehrerer Scripts -- [ ] docs: get local python packages; append to `PYTHON_PACKAGES` -- [ ] `source` Mamba +- [ ] feat(makefile): parallele execution of scripts; multiple servers +- [ ] feat(makefile): sync local env with server and update + +### Other + +- [ ] ops: add datasets via NFS ---