Skip to content

Commit

Permalink
Improve documentation and naming
Browse files Browse the repository at this point in the history
  • Loading branch information
Roman Pavelka committed Aug 1, 2023
1 parent ef7c995 commit 42cae65
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 12 deletions.
File renamed without changes.
32 changes: 20 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,24 @@ Testing how to set up cmake for project with following structure:

```
.
├── CMakeLists.txt
├── include
│   ├── low
│   │   └── low.h
│   └── mid
│   └── mid.h
└── src
   ├── low
   │   └── low.cpp
   ├── main.cpp
   └── mid
   └── mid.cpp
├── Makefile
├── README.md
├── src
│   ├── low
│   │   └── low.cpp
│   ├── main.cpp
│   └── mid
│   └── mid.cpp
└── tests
├── CMakeLists.txt
└── low
└── test_low.cpp
```

and following dependencies (`A -> B` means `A` depends on `B`):
Expand All @@ -25,15 +32,16 @@ main -> mid -> low

Check commits one-by-one as they:

1. start with not using CMake at all and building the thing using plain g++,
1. use the simplest CMake
1. Hide the growing complexity to Makefile
1. Adds configure, build and test to GitHub pipeline.
* start with not using CMake at all and building the thing using plain g++,
* use the simplest CMake
* hide the growing complexity to Makefile
* adds configure, build and test to GitHub pipeline.
* use hierarchical CMake files
* add unit tests
* adds AI based code review

### TODO

1. Use hierarchical CMake files
2. Testing
3. Linting
4. Use external dependencies
5. Use CPM
Expand Down

0 comments on commit 42cae65

Please sign in to comment.