| Cedric Brun | a99fa4c | 2011-07-20 16:41:19 +0200 | [diff] [blame] | 1 | h1. Intent - tooling for writing useful and synchronized documentation |
| 2 | |
| 3 | Intent is a tool allowing developers to easily write a documentation up-to-date with any development artifact (models, code, environment...). |
| 4 | |
| 5 | The documentation, integrated with other Eclipse tools, then becomes truly useful and is no longer a burden that developer have to carry to please their customers or their project manager. |
| 6 | |
| 7 | Based on Donald Knuth's Literate Programming concepts and allowing collaborative work around design tasks, Intent will try to reconcile developers with Documentation. |
| 8 | |
| 9 | h2. Contributing |
| 10 | |
| 11 | see the plugins/org.eclipse.mylyn.docs.intent/dev/README_BEFORE_CODING.textile file to setup your development environment. |
| 12 | |
| 13 | h2. Building |
| 14 | |
| Cedric Brun | 627fa46 | 2011-07-21 11:13:48 +0200 | [diff] [blame] | 15 | Just use maven 3, to build : |
| Cedric Brun | a99fa4c | 2011-07-20 16:41:19 +0200 | [diff] [blame] | 16 | |
| 17 | mvn clean verify |
| 18 | |
| Cedric Brun | 627fa46 | 2011-07-21 11:13:48 +0200 | [diff] [blame] | 19 | to build and *launch the tests* : |
| 20 | |
| 21 | mvn clean package |
| 22 | |
| Cedric Brun | a99fa4c | 2011-07-20 16:41:19 +0200 | [diff] [blame] | 23 | |