Development

Developer Resources

Tincr is released under the GPL version 2 license.

Please feel free to contribute to Tincr.

• An excellent tutorial on Tcl 8.5
• Eclipse has a Tcl plugin - it can be found in their Dynamic Languages Toolkit
• Tincr adheres to the test-driven development (TDD) software development process - it comes with a framework for executing unit tests
• A great resource for using Eclipse with Git

Setup an IDE

• Eclipse
• Visual Studio Code

Updating Tincr's Documentation

Tincr's API documentation is generated from source code using Doxygen. Any time that you make a change to Tincr, we ask that you also update the documentation if appropriate. This can be done by adding/updating comments in the source code according to the Doxygen guidelines, and re-generating the documentation. Instructions for generating the documentation is listed below:

1. Download Doxygen
   • Windows
   • Linux
   • Mac OS X
2. Install Doxygen
3. Launch Doxywizard
4. Load the Doxyfile
   1. File -> Open...
   2. Navigate to %TINCR_PATH%\docs\Doxygen
   3. Select Doxyfile and click Open
5. Generate the documentation
   1. Click on the Run tab
   2. Click Run doxygen
   3. Wait for the process to complete
6. Done! You are ready to commit your changes.

More Information

• Working with Forks
• Pull requests
• Bugs

Tips

• The tincr::refresh_packages command will reload all Tincr packages. This is useful when testing changes you've made to Tincr without needing to restart Vivado