NASPRO - The 'NASPRO Architecture for Sound PROcessing'

User login

Who's online

There are currently 0 users and 0 guests online.

Syndicate

Syndicate content

Valid XHTML 1.0 Strict
Valid CSS
Viewable with Any Browser

Source tree layout

After this necessary preamble, let's a little bit more into details. Having a well organized source tree helps people involved with the project to work more productively and external users (hackers, distributors, etc.) to find what they need more easily. Here's how the source tree should look like after extracting the source archive:

naspro-core-x.y.z
|-- build				auxiliary files needed by the build system
|   |-- <Autoconf files>.m4
|   |-- <Automake files>.am
|   |-- ...
|   |-- Doxyfile
|   |-- nacore.pc.in
|   `-- texinfo.tex
|
|-- doc					documentation
|   |-- reference			auto-generated (English)
|   |   `-- ...
|   |-- <lingua code>			manually written in a given lingua
|   |   `-- <Texinfo source files>.texi
|   `-- fdl.texi
|
|-- i18n				translations
|   `-- ...
|
|-- include				public header files
|   `-- NASPRO
|       `-- core
|           `-- <header files>.h
|
|-- lib					private headers and library source code
|   |-- <project name>			code with external dependencies
|   |   |   `-- <subproject name>
|   |   |       |-- <header files>.h
|   |   |       `-- <source files>.c
|   |   |-- <header files>.h
|   |   `-- <source files>.c
|   |-- <header files>.h
|   `-- <source files>.c
|
|-- tests				tests' source code
|   |-- <source files>.c
|   `-- tests.h
|
|-- AUTHORS
|-- COPYING
|-- ChangeLog
|-- INSTALL
|-- Makefile.am
|-- Makefile.in
|-- NEWS
|-- README
|-- THANKS
|-- aclocal.m4
|-- config.h.in
|-- configure
`-- configure.ac

It should be quite self-explaining, especially for people already having some experience with UNIX-like systems. The only things worth mentioning are the fact that OS-specific code is separated from the rest to simplify porting somehow, and that some build files and scripts are to be found inside the build directory (more specifically Autoconf macros, Automake rules, pkg-config configuration file template, the Doxyfile and everything depending on the AC_CONFIG_AUX_DIR Autoconf macro).

Copyright © 2007, 2008 Stefano D'Angelo