README.md

etrobocon2019

Presented by KatLab.

BUILD

Execution command.

$ ./make.sh

Built the executable file.

$ ls
et2019

DEVELOP

Where is reference?

Here.

Where should you add your source files?

/              // Working directory.
|
|-src          // Don't add here.
| |-module     // Add source codes.
|   |-api      // Add source codes(api).
|     |-core   // Don't add here.
|
|-test         // Add test codes.

Normaly, please put source codes to /src/module.

Where is coding conventions?

Here.

Where is the source directory?

It is src.

How to add module.

If add Example class, append object name to src/Makefile.inc.

before

APPL_CXXOBJS += 

after

APPL_CXXOBJS += \
    Example.o

How to add test cases.

If you add/modify source code, you should add test cases.

1. Create a file named (class name) + "Test".
2. Put the test file to /test.

for example

Create source codes that implement Example class. (/src/Example.cpp, /src/Example.h)

Create a test file for Example class. (ExampleTest.cpp)

Put ExampleTest.cpp to /test.

Execute test cases.

Do ./gtest_all.sh.

Use Remote Development of Visual Studio Code.

You can use Remote Development of Visual Studio Code.