NLSR Developers Guide¶

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.

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/