README.md

   1 # README #
   2
   3 This is an sample readme file for the program NNNNN, it contains instructions
   4 on what this software does, how to install it, where to find the documentation,
   5 where to find the software downloads, where to find the mailing-list, issue
   6 tracker and repository.
   7
   8 ## Description ##
   9
  10 Insert an brief description of what the software does in here, it should describe
  11 everything that you can do with it, in two or three paragraphs.
  12 Then, follow it by an enumeration of some of the killer features of this software.
  13
  14   * Feature N;
  15
  16 ## License ##
  17
  18 This software is licensed under the GNU General Public License version 3 or
  19 later.
  20
  21 or
  22
  23 This software is licensed under the GNU Lesser General Public License
  24 version 3 or later.
  25
  26 or
  27
  28 This software is licensed under the GNU Affero General Public License version 3
  29 or later.
  30
  31 The images, videos, sounds and documentation of this software are licensed under
  32 the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported
  33 License. To view a copy of this license,
  34 visit http://creativecommons.org/licenses/by-nc-sa/3.0/.
  35
  36 ## Install ##
  37
  38 In order to know how to install this software please read the INSTALL.md file.
  39
  40 ## Documentation ##
  41
  42 The documentation of this software is available either on the website or
  43 if you have cloned the repository, in the repository wiki.
  44
  45 Also, there is some documentation available in the doc directory, please
  46 read the INSTALL.md file in order to know how to generate the documentation
  47 in the pdf, html or other format as you wish.
  48
  49 ## Contact ##
  50
  51 In order to contact the software authors, please fo to the software website, given
  52 bellow:
  53
  54 Website URL: <URL_OF_THE_PROJECT_WEBSITE>
  55
  56 Mailing-List: <URL_OF_THE_PROJECT_MAILING_LIST>
  57
  58 Bug/Issue or Feature Tracker: <URL_OF_THE_PROJECT_BUG_OR_ISSUE_OR_FEATURE_TRACKER>
  59
  60 Documentation: <URL_OF_THE_PROJECT_DOCUMENTATION>
  61
  62 Repository: <URL_OF_THE_REPOSITORY_HUMAN_READABLE>