documentation in the docs directory

ufal · Nov 7, 2024 · 8768467 · 8768467
1 parent 90e13fe
commit 8768467
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 6 deletions.
diff --git a/data_preparation/70.releasing/Makefile b/data_preparation/70.releasing/Makefile
@@ -84,15 +84,17 @@ copy_finalize_annot : $(BATCH_PATH).exer_numbers.csv runparser.pl
 		done; \
 	done < $<
 
-prepare : README.md LICENSE.txt
+prepare : LICENSE.txt lindat/README.md lindat/README-cs.md USER_MANUAL.md USER_MANUAL-cs.md TECH_DOC.md TECH_DOC-cs.md
 	mkdir -p $(TGT_DIR)/$(RELEASE_NAME)
+	mkdir -p $(TGT_DIR)/$(RELEASE_NAME)/docs
 	mkdir -p $(TGT_DIR)/$(RELEASE_NAME)/recordings
 	mkdir -p $(TGT_DIR)/$(RELEASE_NAME)/annotations/teitok
 	mkdir -p $(TGT_DIR)/$(RELEASE_NAME)/annotations/simple
 	python copy_rename.py --verbose $(TGT_DIR)/*.mp3 $(TGT_DIR)/$(RELEASE_NAME)/recordings
 	python copy_rename.py --verbose $(TGT_DIR)/*.xml $(TGT_DIR)/$(RELEASE_NAME)/annotations/teitok
 	python copy_rename.py --verbose $(TGT_DIR)/*.txt $(TGT_DIR)/$(RELEASE_NAME)/annotations/simple
-	cp -v $^ $(TGT_DIR)/$(RELEASE_NAME)
+	cp -v LICENSE.txt lindat/README.md lindat/README-cs.md $(TGT_DIR)/$(RELEASE_NAME)
+	cp -v USER_MANUAL.md USER_MANUAL-cs.md TECH_DOC.md TECH_DOC-cs.md $(TGT_DIR)/$(RELEASE_NAME)/docs
 
 zip :
 	cd $(TGT_DIR) && \

diff --git a/data_preparation/70.releasing/lindat/README-cs.md b/data_preparation/70.releasing/lindat/README-cs.md
@@ -28,8 +28,8 @@ Tabulka níže ukazuje statistiky přepisů, přičemž pro každou nahrávku by
 
 ## Dokumentace (k databázi)
 
-- [Uživatelská příručka](USER_MANUAL-cs.md)
-- [Technická dokumentace](TECH_DOC-cs.md)
+- [Uživatelská příručka](docs/USER_MANUAL-cs.md)
+- [Technická dokumentace](docs/TECH_DOC-cs.md)
 
 ## Licence
 

diff --git a/data_preparation/70.releasing/lindat/README.md b/data_preparation/70.releasing/lindat/README.md
@@ -27,8 +27,8 @@ The table below shows the transcription statistics, with one canonical transcrip
 
 ## Documentation (of the database)
 
-- [User Manual](USER_MANUAL.md)
-- [Technical Documentation](TECH_DOC.md)
+- [User Manual](docs/USER_MANUAL.md)
+- [Technical Documentation](docs/TECH_DOC.md)
 
 ## License