Changeset 19926 in project


Ignore:
Timestamp:
08/31/10 16:26:29 (10 years ago)
Author:
Mario Domenech Goulart
Message:

eggs tutorial: removed the files' tag from the .meta example; use "BSD" as example for the license' tag instead of "GPL" ;-); added note about the `extra' directory ("Directory structure" section)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggs tutorial

    r19551 r19926  
    9797
    9898<enscript highlight=scheme>(
    99  ; List here all the files that should be bundled as part of your egg.  Note
    100  ; that (1) mpeg3.meta does not need to be listed here and (2) you might
    101  ; want to include mpeg3-base.scm (if it exists).
    102 
    103  (files "mpeg3.scm" "mpeg3.html" "mpeg3.setup")
    104 
    105  ; Your egg's license:
    106 
    107  (license "GPL")
    108 
    109  ; Pick one from the list of categories (see below) for your egg and enter it
    110  ; here.
    111 
    112  (category web)
    113 
    114  ; A list of eggs mpeg3 depends on.  If none, you can omit this declaration
    115  ; altogether. If you are making an egg for chicken 3 and you need to use
    116  ; procedures from the `files' unit, be sure to include the `files' egg in the
    117  ; `needs' section (chicken versions < 3.4.0 don't provide the `files' unit).
    118  ; `depends' is an alias to `needs'.
    119  (needs sandbox syntax-case)
    120 
    121  ; A list of eggs required for TESTING ONLY.  See the `Tests' section.
    122  (test-depends test)
    123 
    124  (author "Your Name Goes Here")
    125  (synopsis "A basic description of the purpose of the egg."))</enscript>
     99; Your egg's license:
     100(license "BSD")
     101
     102; Pick one from the list of categories (see below) for your egg and enter it
     103; here.
     104(category web)
     105
     106; A list of eggs mpeg3 depends on.  If none, you can omit this declaration
     107; altogether. If you are making an egg for chicken 3 and you need to use
     108; procedures from the `files' unit, be sure to include the `files' egg in the
     109; `needs' section (chicken versions < 3.4.0 don't provide the `files' unit).
     110; `depends' is an alias to `needs'.
     111(needs sandbox syntax-case)
     112
     113; A list of eggs required for TESTING ONLY.  See the `Tests' section.
     114(test-depends test)
     115
     116(author "Your Name Goes Here")
     117(synopsis "A basic description of the purpose of the egg."))
     118</enscript>
    126119
    127120For the category entry you can use any of the following:
     
    196189; {{tags}} : You should keep one subdirectory of this directory for every release for your egg.  The names of the directories here should correspond to the version number of their associated release.
    197190; {{branches}} : Contains, as subdirectories, any special branches of the code that need to be maintained apart from the trunk.
     191; {{extra}} : files that you want to keep under version control but are not required to be installed by {{chicken-install}}
    198192
    199193For documentation, there is a {{wiki}} directory at the top-level of the repository. It holds the entire contents for this wiki.
Note: See TracChangeset for help on using the changeset viewer.