Skip to content

Commit 1019adc

Browse files
committed
Update readme
1 parent 90d5cea commit 1019adc

1 file changed

Lines changed: 14 additions & 23 deletions

File tree

README.md

Lines changed: 14 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,8 @@ A framework combining C language state machines and multicast asynchronous callb
1212
- [C Language State Machine with Threads](#c-language-state-machine-with-threads)
1313
- [Table of Contents](#table-of-contents)
1414
- [Introduction](#introduction)
15-
- [Project Build](#project-build)
16-
- [Windows Visual Studio](#windows-visual-studio)
17-
- [Linux Make](#linux-make)
15+
- [Related repositories](#related-repositories)
16+
- [Getting Started](#getting-started)
1817
- [SelfTestEngine](#selftestengine)
1918
- [CentrifugeTest](#centrifugetest)
2019
- [Timer](#timer)
@@ -33,32 +32,24 @@ A framework combining C language state machines and multicast asynchronous callb
3332

3433
<p>The primary focus is on how to combine the state machine and asynchronous callbacks into a single framework.</p>
3534

36-
<p>A CMake build offers easy experimentation in Windows, Linux and other platforms. No platform specific API's are utilized so any compiler toolchain will suffice.</p>
37-
38-
Related repositories:
35+
## Related repositories
3936

4037
<ul>
41-
<li><a href="https://github.com/endurodave/C_StateMachine">State Machine Design in C</a></li>
42-
<li><a href="https://github.com/endurodave/C_AsyncCallback">Asynchronous Callbacks in C</a></li>
43-
<li><a href="https://github.com/endurodave/C_Allocator">A Fixed Block Allocator in C</a></li>
44-
<li><a href="https://github.com/endurodave/StateMachine">State Machine Design in C++</a></li>
38+
<li><a href="https://github.com/endurodave/C_StateMachine">State Machine Design in C</a> - A compact C language finite state machine (FSM) implementation.</li>
39+
<li><a href="https://github.com/endurodave/C_AsyncCallback">Asynchronous Callbacks in C</a> - Asynchronous callbacks library in C.</li>
40+
<li><a href="https://github.com/endurodave/C_Allocator">A Fixed Block Allocator in C</a> - A C language fixed block memory allocator.</li>
41+
<li><a href="https://github.com/endurodave/StateMachine">State Machine Design in C++</a> A C++ finite state machine (FSM) implementation.</li>
42+
<li><a href="https://github.com/endurodave/StateMachineWithThreads">C++ State Machine with Threads</a> - A C++ state machine integrated with an asynchronous callback library.</li>
4543
</ul>
4644

47-
# Project Build
48-
49-
<a href="https://www.cmake.org">CMake</a> is used to create the build files. CMake is free and open-source software. Windows, Linux and other toolchains are supported. Example CMake console commands executed inside the project root directory:
50-
51-
## Windows Visual Studio
52-
53-
<code>cmake -G "Visual Studio 17 2022" -A Win32 -B ../C_StateMachineWithThreadsBuild -S .</code>
54-
55-
After executed, open the Visual Studio project from within the <code>C_StateMachineWithThreadsBuild</code> directory.
56-
57-
## Linux Make
45+
# Getting Started
5846

59-
<code>cmake -G "Unix Makefiles" -B ../C_StateMachineWithThreadsBuild -S .</code>
47+
[CMake](https://cmake.org/) is used to create the project build files on any Windows or Linux machine.
6048

61-
After executed, build the software from within the C_StateMachineWithThreadsBuild directory using the command <code>make</code>. Run the console app using <code>./C_StateMachineWithThreadsApp</code>.
49+
1. Clone the repository.
50+
2. From the repository root, run the following CMake command:
51+
`cmake -B Build .`
52+
3. Build and run the project within the `Build` directory.
6253

6354
# SelfTestEngine
6455

0 commit comments

Comments
 (0)