Skip to content

Commit

Permalink
Added Step-by-step porting guide
Browse files Browse the repository at this point in the history
  • Loading branch information
suikan4github committed Feb 19, 2019
1 parent b2a12bf commit 73a1638
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 2 deletions.
57 changes: 57 additions & 0 deletions Inc/murasaki_5_spg.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
/**
* @file murasaki_5_spg.hpp
* @brief Step by Step Porting guide
*/


/**
* @page spg Step-by-Step Porting Guide
* @brief This chapter go though the actual operation of the CubeMX and SW4STM32 to
* create an empty application with Murasaki.
*
* @details
* @li @subpage spg_1
* @li @subpage spg_2
* @li @subpage spg_3
* @li @subpage spg_4
* @li @subpage spg_5
*
*/

/**
* @page spg_1 UART configuration
* @brief UART is grouped as connectivity device.
*
* @details
*
* @image html "Screenshot from 2019-02-18 08-42-34.png" "CubeMX"
* @image latex "Screenshot from 2019-02-18 08-42-34.png" "CubeMX"
*
*/

/**
* @page spg_2 CPU, EXTI, and System tick configuration
* @brief System group contains CPU, EXTI and System tick timer.
*/

/**
* @page spg_3 FreeRTOS configuration
* @brief To run a FreeRTOS application, the heap memory and the default memory
* have to be configured.
*/

/**
* @page spg_4 Clock configuration
* @brief This is required becaue of the Nucleo F722 bug of the CubeMX.
*/

/**
* @page spg_5 Project configuration and code generation
* @brief At last, we configure the SW4STM32 project and generate a code
*/

/**
* @page spg_5 Clone the Murasaki repogitory and install
* @brief At last, we configure the SW4STM32 project and generate a code
*/

4 changes: 2 additions & 2 deletions doc/murasaki.doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -771,7 +771,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.

INPUT = ../Inc ../Inc-tp ../../Inc ../Src ../../Src
INPUT = ../Inc ../Inc-tp ../../Inc ../Src ../../Src

# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
Expand Down Expand Up @@ -864,7 +864,7 @@ EXAMPLE_RECURSIVE = NO
# that contain images that are to be included in the documentation (see the
# \image command).

IMAGE_PATH =
IMAGE_PATH = ../doc/image

# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
Expand Down

0 comments on commit 73a1638

Please sign in to comment.