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

Set up Eclipse

1. Create an account at GitHub.com
2. Download and install Eclipse
3. Install the Dynamic Languages Toolkit Tcl plugin for Eclipse
4. In Eclipse, navigate to "Help" -> "Install new software..."
5. In the dropdown labeled "Work with:", select "Mars - http://download.eclipse.org/releases/mars"
6. Expand "Programming Languages" and check the box next to "Dynamic Languages Toolkit - TCL Development Tools"
7. Proceed through the rest of the installer, restart when prompted
8. Clone the Tincr repo from GitHub
9. In Eclipse, navigate to "File" -> "Import..."
10. In the dialog that comes up, expand the folder "Git", select "Projects from Git", and press "Next"
11. Select "Clone URI" and press "Next"
12. Paste the following into the "URI" textbox: "https://github.com/bradselw/tincr.git"
13. Enter your GitHub credentials if you wish and press "Next"
14. Select the branches you want to clone and press "Next"
15. Enter the directory where you want to clone the repo (i.e. "C:\code\git\tincr") and press "Next"
16. Select "Import using the New Project Wizard" and press "Finish"
17. Create a Tcl project for Tincr
18. In the "New Project" dialog, expand "Tcl" and select "Tcl Project", and press "Next"
19. Name your project (i.e. "tincr")
20. Select "Create project at existing location" and browse to the path to the repo you cloned in the previous step (i.e. "C:\code\git\tincr") and press "Next"
21. Remove everything from the build path except the "tincr" and "tincr_test" top-level folders
22. Press "Finish"
23. Install Tincr
24. Create an environment variable named TINCR_PATH and set it to the root of the local Tincr repo (i.e. "C:\code\git\tincr")
25. Copy "pkgIndex.tcl" from the "install" directory in the repo to the following directory in your Vivado installation: "\tps\tcl\tcl8.5"

Submit a Pull Request

Whenever features are added or bugs are fixed, these should be submitted via a pull request. Below outlines how to fix a bug in master using Eclipse:

1. Make sure there is an issue filed for the work you will be doing. In this example, we will be fixing issue #1
2. Create a "topic branch"
3. Change to the branch that you would like to submit the fix to. In this case, I switched to "master"
4. Create a new branch from the current branch 1. Right-click on the root node in Script Explorer 1. Team -> Switch To -> New Branch... 1. Give the branch a name and check "Configure upstream for push and pull" 1. Click "Finish"
5. Make your changes
6. Commit your changes and push to remote
7. Right-click on the root node in Script Explorer
8. Team -> Commit...
9. Fill out the form: First line should be a short description, the rest should be a longer description
10. Click "Commit and Push" to commit your changes to your local branch and push to the remote server
11. Click "Ok" on the summary page

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