Project

General

Profile

NLSR Developers Guide » History » Version 1

Nicholas Gordon, 10/31/2017 01:25 PM
Wrote the initial Redmine wiki page for the developer's guide.

1 1 Nicholas Gordon
# NLSR Developers Guide
2
3
Part of any successful project is the manual. For NLSR, there is a continually-updated manual, distributed as .tex source files, that lives in the same repository as the source, only in a separate branch, `developers-guide`. That is, if you have successfully cloned the repo and are developing for NLSR, you already have the newest version of the guide, too. There is also a pre-compiled `.pdf` file, saving you the trouble, but it is not guaranteed to be up-to-date. To be absolutely sure, you should build the document yourself.
4
5
If you don't know what LaTeX is, or you need help building the files, you should probably start at the LaTeX homepage, https://www.latex-project.org/