How to submit sample code and projects

From Crypto++ Wiki
Jump to: navigation, search

The Crypto++ community is always grateful when someone offers to share their knowledge. Should you desire to particpate by uploading a sample file or project, please observe the following so that others may enjoy your contribution.

How to Submit

The Crypto++ Wiki is a dynamic site. As such, the author can:

  • Add an Example to an Existing Page
  • Tack a Page on the Site
  • Contact the Users Group, and request a SideBar for guidance

Where to Submit

Most Samples and Examples have an obvious fit. If unsure, send a message to the Users Group.

Console Application

If possible, attempt to demonstrate your code using a Console Application. Most of the time, good old cout does an excellent job. Adding Windows and MFC code can obfuscate the point at times. Additionally, if the the person who is studying your example is working with Unix or Linux, the code will be less than usable.

Comment as Required

No one likes to document. But a little insight can go a long way...

Archive Program

Please select an archive format which will reach a large audience. File formats such as *.gz, *.tar, and *.rar may require your audience member to download an additional program before the he or she can begin enjoying your sample.

Clean Unneeded Files and Folders

Most users can build your code on their platform, so there is no need to include the Debug and Release subdirectories. Also, you can delete the *.ncb file, *.suo file, and *.aps file. Visual Studio will recreate them when the project is opened on the end user's machine. In the example below, notice the Debug and Release directories are not included (or files from those directories).

Archive.png

Archive the Parent Directory

Archive the parent directory, and not the individual files. This keeps the Desktop tidy. In the example below, notice all files share a single parent directory.

Archive.png