sandbox template update with apologies
Hello, A couple weeks ago I found out that the sandbox template script (which is supposed to customize a template to give a new boost developer a good starting point for a new project) not only required python 2.5 but also ran only under windows... My sincere apologies to anyone that tried the script outside the very limited context in which it worked, only to find it a waste of time - I should have known better than to test only on windows... Anyway, I have since spent some time to make the script compatible with Python 2.3, added automatized testing scripts, and tested both on windows and os x. Here are some use cases for the script, which you can try out from the template-under-construction directory of the boost sandbox, if you happen to be starting a new boost sandbox project. In each case, the script will generate the recommended directory tree for the project with a simple library implementation, tests, example, doc source and build files. To start a new sandbox project (the script will ask you for any required information): python file_template.py sandbox To start a new sandbox project and provide the required information in the command line: python file_template.py sandbox library=my_library "authors=John J. Doe" To start a new sandbox project with the optional Xcode and MSVC IDE projects and a non-default documentation format: python file_template.py sandbox library=file_template "authors=Stjepan Rajko" docs=qb xcodeide=y vc8ide=y To ignore the code provided in the template, and instead integrate your existing code into the new sandbox project: python file_template.py sandbox library=my_library "authors=John Doe,Jane Dough" fignore=.hpp fignore=.cpp /path/to/existing/my_library into=my_library The documentation has more informationon both the sandbox template and the template processor: http://dancinghacker.com/code/template/ If you decide to try this out I'd appreciate your feedback. Best regards, Stjepan
Stjepan Rajko said: (by the date of Mon, 25 Jun 2007 12:31:24 -0700)
Hello,
A couple weeks ago I found out that the sandbox template script (which is supposed to customize a template to give a new boost developer a good starting point for a new project)
Wouldn't it be useful to put the information about your script in Boost Documentation in proper place? I think that you can ask Matias about where to put it - he knows boost docs from insideout. -- Janek Kozicki |
On 6/25/07, Janek Kozicki <janek_listy@wp.pl> wrote:
Stjepan Rajko said: (by the date of Mon, 25 Jun 2007 12:31:24 -0700)
Hello,
A couple weeks ago I found out that the sandbox template script (which is supposed to customize a template to give a new boost developer a good starting point for a new project)
Wouldn't it be useful to put the information about your script in Boost Documentation in proper place? I think that you can ask Matias about where to put it - he knows boost docs from insideout.
Eventually, this would be great, but the script is currently very new and untested in practice, and really needs input from the community on whether it is useful and if so, how it can be improved. Until it seems like the template is really doing what it's supposed to be doing (making it easy to start a new boost project), and that the files/directories it generates are up-to-date with Boost guidelines, follow recommended practice in their use of Boost.Build and Boost.Test etc., I think the proper place is far away from any official boost page :-). Thanks for the suggestion, but let's wait for some feedback first, and then maybe we can see where this should go... Regards, Stjepan
Stjepan Rajko wrote:
On 6/25/07, Janek Kozicki <janek_listy@wp.pl> wrote:
Stjepan Rajko said: (by the date of Mon, 25 Jun 2007 12:31:24 -0700)
Hello,
A couple weeks ago I found out that the sandbox template script (which is supposed to customize a template to give a new boost developer a good starting point for a new project) Wouldn't it be useful to put the information about your script in Boost Documentation in proper place? I think that you can ask Matias about where to put it - he knows boost docs from insideout.
Eventually, this would be great, but the script is currently very new and untested in practice, and really needs input from the community on whether it is useful and if so, how it can be improved. Until it seems like the template is really doing what it's supposed to be doing (making it easy to start a new boost project), and that the files/directories it generates are up-to-date with Boost guidelines, follow recommended practice in their use of Boost.Build and Boost.Test etc., I think the proper place is far away from any official boost page :-).
:-) Actually, I believe the docs should remain close to the code (as is custom with other boost projects). The wiki seems a fine place to discuss things, and point at the project. Regards, Stefan -- ...ich hab' noch einen Koffer in Berlin...
On 6/25/07, Stefan Seefeld <seefeld@sympatico.ca> wrote:
Actually, I believe the docs should remain close to the code (as is custom with other boost projects). The wiki seems a fine place to discuss things, and point at the project.
The wiki does sound like a good place :-) - I added a page at: http://svn.boost.org/trac/boost/wiki/SandboxTemplate and linked to the other documentation. I also included a built version of the HTML docs in the subversion. Thanks, Stjepan
On 6/25/07, Stjepan Rajko <stipe@asu.edu> wrote:
On 6/25/07, Stefan Seefeld <seefeld@sympatico.ca> wrote:
Actually, I believe the docs should remain close to the code (as is custom with other boost projects). The wiki seems a fine place to discuss things, and point at the project.
The wiki does sound like a good place :-) - I added a page at:
http://svn.boost.org/trac/boost/wiki/SandboxTemplate
and linked to the other documentation. I also included a built version of the HTML docs in the subversion.
I really like it. Neat idea Stjepan! Can you make it generate this diretory structure for docs? http://svn.boost.org/trac/boost/wiki/DocsTranslationsProject#Organizationint... Thanks! Best regards Matias
participants (4)
-
Janek Kozicki -
Matias Capeletto -
Stefan Seefeld -
Stjepan Rajko