Read Me

Note: Do not edit this file.
This file is maintained by the core developers and changes will be lost.

Getting started with developing your project
============================================

The instructions below are for command-line SVN. If you are using a GUI, like TortoiseSVN, please adapt the instructions accordingly.

1. Create the directory coco in a location of your choice:

	mkdir coco

2. Change to coco and execute the following commands:

	svn checkout https://svn.code.sf.net/p/cocotools/code/trunk toolbox/core
	svn checkout https://svn.code.sf.net/p/cocotools/covering/code/trunk toolbox/covering
	svn checkout https://svn.code.sf.net/p/cocotools/auto/ep/trunk toolbox/ep
	svn checkout https://svn.code.sf.net/p/cocotools/auto/coll/trunk toolbox/coll
	svn checkout https://svn.code.sf.net/p/cocotools/auto/po/trunk toolbox/po
	svn checkout https://svn.code.sf.net/p/cocotools/examples/recipes/trunk examples/recipes

3. Read the information below, listing basic SVN commands, and change the default SVN configuration as explained at the end of this text.

4. Change to the Matlab startup directory for your system (any folder returned by the Matlab-function 'userpath'). Create or open the file startup.m and add the line

	run PATH_TO_COCO/toolbox/core/admin/startup

where PATH_TO_COCO is the full path of the directory coco created in step 1.

5. After restarting Matlab, all coco toolboxes should now be in the search path. You can start working on your toolbox. You will be able to commit changes to any toolbox that you are a developer of. Please do not make changes to any other toolbox. Instead, report a bug or a request for change to one of its developers.

###############################################
# more information about SVN on:
http://svnbook.red-bean.com

# check status, no network access to repository required
svn status [FILE ...]

# check status and for updates in repository
svn status -u [FILE ...]

# update (local) working copy:
svn update [FILE ...]

# view (local) differences since last update:
svn diff FILE

# commit (local) changes:
svn commit -m "message" [FILE ...]

# add/delete/create files and directories:
svn add|delete|mkdir FILE ...

# copy/move files and directories:
svn copy|move SRC DST

###############################################
# Definitions in svn config file that are very useful
# for developing coco toolboxes in Matlab.
#
# see the user-config file ~/.subversion/config
# relevant fragments:

[miscellany]
enable-auto-props = yes
global-ignores = *.o *.so *.dll *.mex .*.rej *.rej .*~ *~ .asv .DS_Store local data

[auto-props]
*.c = svn:eol-style=native;svn:keywords=Date Revision Author HeadURL Id
*.cpp = svn:eol-style=native;svn:keywords=Date Revision Author HeadURL Id
*.rc = svn:eol-style=native;svn:keywords=Date Revision Author HeadURL Id
*.h = svn:eol-style=native;svn:keywords=Date Revision Author HeadURL Id
*.tex = svn:eol-style=native;svn:keywords=Date Revision Author HeadURL Id
*.m = svn:eol-style=native;svn:keywords=Date Revision Author HeadURL Id
*.txt = svn:eol-style=native;svn:keywords=Date Revision Author HeadURL Id
*.rc = svn:mime-type=text/windows-resource-file
*.png = svn:mime-type=image/png
*.jpg = svn:mime-type=image/jpeg
*.eps = svn:mime-type=application/postscript
*.ps = svn:mime-type=application/postscript
*.pdf= svn:mime-type=application/pdf
Makefile = svn:eol-style=native;svn:keywords=Date Revision Author HeadURL Id