Welcome to the CrypTool 2 developer trac
Content
This wiki contains relevant information with respect to the CrypTool 2 project. For instance, you'll find here the necessary information for accessing our source code by using SVN.
Our trac is also a "window" into the CrypTool 2 source code. With the "Browse Source" button above you can browse our source code without the need for installing a SVN client. If you found a bug, or you have a feature request, please feel free to submit a ticket with our ticketing system by pressing the "New Ticket" button from above. When you press the "Timeline" button from above you'll get the latest activities with respect to source code or wiki changes. This way you can follow closely the development of this project.
Additionally it should be used as a platform for sharing information between the different developers and partners working on this project at different locations.
See AboutTrac to get more information about trac. For a complete list of local wiki pages, see TitleIndex.
Project Organisation
Sub-Projects
Developer Guidelines and Howtos
If you just start developing something for this project, you probably have a lot of questions how you should do this or that. That's why we put together some How-Tos and some guidelines. Naturally you'll start by installing an SVN client and trying to checkout our sources. All information in order to do so, you are going to find in our Plugin Developer Manual, see below.
- https://www.youtube.com/playlist?list=PLMuvAbyIl0PTTfPE2VhJ9PZ6qlOG0MMaX -- A video series on CrypTool 2 development
- How to start -- Brief introduction
- Plugin Developer Manual -- describes in detail how to retrieve the source code and create a new plugin
- Plugin Developer checklist -- most important things that really should be done before starting developing
- CrypTool Plugin Template -- for use with Visual Studio 2019 (Readme)
- Developer compendium with terms and definitions
- Plugin Howtos:
- Understand the IPlugin Interface
- How to define the Plugin Attributes
- How to use the ICryptoolStream Data Type
- How to add an XML User Documentation
- How to add Multi-Language support
- How to add your plugin to the Wizard
- How to add a standard analysis visualization to your plugin
- General programming tips
- Frequently Asked Questions
Information for core developers and administrators (advanced):
- How to Create an SVN/Developer Account
- How to Update the peers@play P2P Lib
- How to Update the CrypTool 2 Plugin Template for Visual Studio
- How to Release a Beta Milestone
- How to Delete spam tickets
- How to Generate the functionality table (WIP)
Software Design Documents
- BuildSetup -- requirements of installer and automated build process on server
- KeySearcher OpenCL
- IPlugin Requirements
- Network Editor
- WorkspaceManager (view)
- WorkspaceManagerModel (data model and execution logic)
- CrypTutorials (the editor/video player for cryp tutorial videos)
Quality Assurance
- Testing plugins and samples
- Visual Studio Profiling -- how to use VS profiling to find performance and memory leaks
- Plugin requirements -- requirements your plugin must fulfill in order to be included in the stable release
- Online Documentation Update 2011
- Discussion: Components which should NOT come into RC1/Release
