source: cpp/README.txt @ 1088

Last change on this file since 1088 was 1056, checked in by Maciej Komosinski, 4 years ago

Cosmetic

  • Property svn:eol-style set to native
File size: 2.5 KB
Line 
1_______________ Building SDK demos and test applications ________________
2
3make -f frams/Makefile-SDK sdk_tests
4
5
6Even if you don't use 'make', you can create a project for your favorite
7development environment. The sources should compile under *nixes, osx,
8windows (visual C++, borland/embarcadero), cygwin, android, ios, and tizen.
9
10
11___________________________ Source directories __________________________
12
13   +- common           - general compatibility layer, utilities
14   +- frams            - Framsticks modules
15      +- _demos        - SDK tests and sample applications
16      +- canvas        - neural network layouts and drawing
17      +- config        - SDK elements declarations
18      +- genetics      - genetic operators and converters between genetic formats
19         +- f1         - ...for genetic format f1 (recurrent encoding)
20         +- f4         - ...for genetic format f4 (developmental encoding)
21         +- f9         - ...for genetic format f9 (3D turtle encoding)
22         +- fB         - ...for genetic format fB ("biological" encoding)
23         +- fF         - ...for genetic format fF (Foraminifera encoding)
24         +- fH         - ...for genetic format fH (multidimensional handles)
25         +- fL         - ...for genetic format fL (Lindenmayer systems)
26         +- fS         - ...for genetic format fS (similar to f1, but for solid shapes)
27         +- fn         - ...for genetic format fn (numerical optimization encoding)
28         +- fT         - ...for genetic format fT (educational: ATGC sequences)
29      +- loggers       - printing and redirecting logMessage() and logPrint() messages
30      +- model         - body: parts, joints; brain: neurons, connections
31         +- geometry   - compute dimensions, volume, surface area
32         +- similarity - determine structural and geometric similarity
33      +- neuro         - neural network simulation
34         +- impl       - neuron classes implementations
35      +- param         - C++/properties access objects
36      +- util          - Framsticks-related utilities
37      +- virtfile      - object-oriented FILE* replacement
38      +- vm            - virtual machine programming: FramScript grammar (lex and yacc/bison)
39          +- classes   - C++ interfaces and implementations of basic FramScript objects
40
41
42______________________ Source formatting guidelines _____________________
43
44File names: all letters are lower case, with '-' as word separator if needed.
45Indents: tab
46Scopes
47{
48        ClassName variable_lower_case;
49        variable_lower_case.camelCaseMathodOrFunction();
50}
Note: See TracBrowser for help on using the repository browser.