Update of /cvsroot/leaf/bin/packages/uclibc-0.9/28/contrib
In directory sfp-cvsdas-2.v30.ch3.sourceforge.com:/tmp/cvs-serv19309

Added Files:
        README 
Log Message:
this is missing for years :)


--- NEW FILE: README ---
In order to get a decent result from the script that creates the Bering uClibc 
packages page, please always add:
* a .help file (in /var/lib/lrpkg/packaganame.help)
* a .version file (in /var/lib/lrpkg/packaganame.version)

In order to help others recreate your package, please also supply a 
"packagename.txt" file with the following contents:
* an URL where the sources can be downloaded (including any patches used)
* the configuration (options given to ./configure or modification made to the 
  makefle) used when compiling the program
* Any special steps needed to compile the program
* Dependencies that need to be fulfilled on the build plattform.

For examples on what such a file should contain, please take a look at 
http://cvs.sourceforge.net/viewcvs.py/leaf/src/bering-uclibc/apps/bash/bash.mk?view=markup
for the build instructions, and 
http://cvs.sourceforge.net/viewcvs.py/leaf/src/bering-uclibc/apps/bash/bash.txt?view=markup
for the other information. It is ok to put everything into one single file, 
no need to turn it into separate files (or even a makefile). 

The .help file should comply to these guidelines:
At all times, try to keep lines in the .help file less than 80 characters wide 
- 
otherwise, things will look strange in the LEAF box
Avoid using the "/" character in the first line of the description - it seems 
to mess
up the lrpkg script (so doing a "lrpkg -l" on the leaf box will produce 
corrupted output
if a "/" is in the first line of the .help file)

The structure of the .help file should look like this:

Start with a very short description of the package (preferrably 1 or 2 lines)
One line that specifies the homepage of the source of the package, starting 
with "See" 
or "Homepage"
Next, you should supply a list of requirements (if applicable). In short, if 
your package requires another package to be installed, specify the 
package-name(s) here, in a line starting with "Requires". You may specify the 
package names with or without the ".lrp" extension. The list should be 
delimited by spaces.
Finally, a line specifying who created the package (preferrably with 
email-address). 
This line can (but doesn't have to) contain the date the package was created 
(so 
people can distinguish different versions of the package more easily), 
preferrably with 
the date in ISO format (YYYY-MM-DD), to allow for the international nature of 
our 
user-base.

After that, there should be a blank line, followed by a more verbose 
description, 
instructions, whatever your package needs. Everything that follows the blank 
line is 
ignored by the script that creates the packages page.

Sample:
-------------------------------------------------------------------
Some Sample project
Short description that gives an idea of what the program is used for
Requires: somepackage someotherpackage anotherpackage
LEAF package by YourName, [email protected] 2004-03-13

Longer description, howtos, FAQ, whatever you want 
(well, within reason).

-------------------------------------------------------------------


------------------------------------------------------------------------------
Increase Visibility of Your 3D Game App & Earn a Chance To Win $500!
Tap into the largest installed PC base & get more eyes on your game by
optimizing for Intel(R) Graphics Technology. Get started today with the
Intel(R) Software Partner Program. Five $500 cash prizes are up for grabs.
http://p.sf.net/sfu/intelisp-dev2dev
_______________________________________________
leaf-cvs-commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/leaf-cvs-commits

Reply via email to