devspec.en_US/6.4.src-pkg-dir-structure.txt

   1 \r
   2 \r
   3 # dir of src pkg\r
   4 ================\r
   5 \r
   6     look at the directory of sample project, and the meaning of every dir is:\r
   7 \r
   8 @ build: pkg build info. it's equal to a makefile, it guide the compiler to \r
   9   build the src-pkg.\r
  10 @ bin: script executable programs.\r
  11 @ shlib: shell script library.\r
  12 @ doc: include all document files.\r
  13 @ src: c/cpp src code dir.\r
  14 @ lib: build as a static lib, and link to the other program.\r
  15 @ testing: test script dir. use scripttest to test it.\r
  16 @ res: resource file beyound binary and src-code. such as config file, data\r
  17   files, fonts, pictures, and so on.\r
  18 @ readme.md/readme.txt/README.txt/README.md. soft-pkg introduce file.\r
  19 \r
  20 \r
  21 \r
  22 # document dir\r
  23 ==============\r
  24 \r
  25     the dir of 'doc' include many document files:\r
  26 \r
  27 @ LISENCES/COPYING. it shows the intellectual property rights of a soft-pkg.\r
  28 # AUTHORS/authors/authors.txt/AUTHORS.txt. it include author info.\r
  29 # THANKS. record the person helps to the soft-pkg.\r
  30 # BUILD-DEP. it record the dependent pkg name, website, for building.\r
  31 # EXEC-DEP. it record the dependent pkg name, website, for executing.\r
  32 # NEWS/news.txt. it shows the new feature in current version.\r
  33 # ChangeLog/ChangeLog.txt. software update record every function feature \r
  34   version of the pkg.\r
  35 # INSTALL/install/install.txt/INSTALL.txt. compile build step document.\r
  36 # TODO. the features to be developed, the bug to be fixed.\r
  37 # README.dev. it's a doc file for developers who want to develop for this soft\r
  38   pkg.\r
  39 \r
  40 # UM.man.en_US/UM.man.zh_CN. user manual file in man format with different\r
  41   language.\r
  42 # API-Doc. if the soft-pkg is a library, it include an API-Doc dir for it \r
  43   instead of user manual.\r
  44 # example. example dir. sometimes, testing dir include many examples. so it is \r
  45   not needed normally.\r
  46 # tutorial. tutorial files for soft-pkg using. it uses ttyrec, or gif file.\r
  47 # design. if the soft-pkg uses graphical design tools, such as uml diagram. or\r
  48   it stores txt/md design doc files.\r
  49 # tagdoc. it stores feature list, demand text, iead note, and so on. it uses\r
  50   tag-doc to save different type of info. delete infos except feature list when \r
  51   the pkg would be published.\r
  52 # tagdoc£¬tagdoc¼ÇÂ¼µÄÒ»Ð©ÎÄµµµÄ±£´æ¡£tagdoc°üÀ¨£º¹¦ÄÜÃèÊöÎÄ×Ö£¬feature-list£¬todolist£¬\r
  53 # \r
  54 \r
  55 \r
  56 \r
  57 \r
  58 \r
  59 @ Ò»¸öÈí¼þ°ü°üº¬µÄÎÄµµ£¬±£´æÔÚdocÄ¿Â¼ÖÐ¡£\r
  60 # LISENCESÎÄ¼þ£¬¶ÔÈí¼þ°üµÄÊ¹ÓÃÈ¨ÏÞ¡¢ÓÃÍ¾µÄËµÃ÷¡£\r
  61 # readme.md/readme.txt/README.txt/README.md£¬ÒÔmdÓï·¨±àÐ´µÄËµÃ÷ÎÄµµ£¬°üº¬¹¦ÄÜÓÃÍ¾¸ÅÊö£¬feature-list\r
  62 # author/author.txt/AUTHOR/AUTHORMtxt£¬°üº¬Èí¼þ¿ª·¢ÕßÐÅÏ¢\r
  63 # changelog/changelog.txt£¬Èí¼þ°æ±¾¸üÐÂÊ±µÄ¹¦ÄÜ¼ÇÂ¼¡£\r
  64 # install/install.txt/INSTALL/INSTALL.txt£¬³ÌÐò±àÒë¡¢°²×°ÎÄµµ¡£\r
  65 # todolist£¬\r
  66 \r
  67 # man-pages£¬man/info°ïÖúÐÅÏ¢¡£\r
  68 # API-Doc£¬Èç¹ûÊÇlib¿â£¬°üº¬Ò»¸öapiÎÄµµÄ¿Â¼¡£\r
  69 # example£¬Ê¹ÓÃµÄÀý×Ó³ÌÐò¡£\r
  70 # tutorial£¬³ÌÐò¡¢libÊ¹ÓÃµÄÀý×Ó£¬ÒÔgif¡¢ttyrec¡¢ÊÓÆµµÈ¸ñÊ½±£´æ¡£\r
  71 # design£¬³ÌÐòÎÄ×ÖÐÔµÄÉè¼ÆËµÃ÷ÎÄµµ¡£\r
  72 # tagdoc£¬tagdoc¼ÇÂ¼µÄÒ»Ð©ÎÄµµµÄ±£´æ¡£tagdoc°üÀ¨£º¹¦ÄÜÃèÊöÎÄ×Ö£¬feature-list£¬todolist£¬\r
  73 \r