Commits

clallier  committed ed0219c

add command line documentation

  • Participants
  • Parent commits 29c033a

Comments (0)

Files changed (1)

File documentImageCreator/src/gui/AncientDocumentEditor/src/main.cpp

 
 #include "Document/lipsum.h"
 
+/**
+  * AncientDocumentEditor has two modes :
+  *
+  * 1) standard : run in GUI mode, let user import font, write texte, export, etc
+  * 2) command line mode : generate an image from a specific texte file
+  *     args are :
+  *     --font="fontname" : select a specific font for rendering
+  *     --bg="backgound.jpg" : select a specific background image for rendering
+  *     --inputfile="input.txt" : set an input file to read an render
+  *     --inputrep="directoryName" : set an input directory, will scan all textes files and render them
+  **/
 int main(int argc, char *argv[])
 {
     QApplication a(argc, argv);