README.md
1The 2017 branch is the stable branch this year, it is synchronized with the TeXLive svn repository.
2The 2017-1.20 branch is a working branch.
3
4See synctex_version.h to see the latest version of synctex and of the parser.
5
6# SyncTeX
7
8Synchronization for TeX
9
10This is a partial clone of synctexdir in the TeXLive svn repository, see the online [TeXLive repository](http://www.tug.org/svn/texlive/trunk/Build/source/texk/web2c/synctexdir/).
11
12The focus here is on the client side code for synchronization between text editor and pdf viewer.
13Instructions below are given to build the `synctex` command line tool on possibly various operating systems.
14
15## Clone
16Clone the git repository
17
18## Instruction for OS X
19These instructions are for Xcode 7 but they might apply as well for other versions.
20
21### create a new project
22
23- create a new project
24- choose a command line tool project
25- set the product name to synctex
26- set the language to C
27- save it next to the synctexdir folder just cloned
28- in the navigation pane, remove the default syntex folder and its `main.c` default contents
29
30you then have both folders synctex and synctexdir in the same directory.
31
32### Add sources
33
34- select the synctex project in xcode navigation left pane
35- select menu itme File->Add files to "synctex"
36- select the synctexdir folder in the file browser
37- uncheck "Copy items if needed"
38- choose "Create groups"
39- validate your choice
40- select the synctex project
41- go to the build phase pane
42- remove `Readme.md` from the compile sources list
43
44You end with 3 sources : `synctex_main.c`, `synctex_parser.c`, `synctex_parser_utils.c`
45
46### Setup project
47
48- add `-DSYNCTEX_WORK` as other C flag (or `SYNCTEX_WORK` preprocessor macro)
49- set Always Search User Path build setting to YES
50- in the build phase pane, link to libz1.2.5.tbd (or similar)
51
52You are ready to build
53