Update READMEs
This commit is contained in:
25
cpp/README.md
Normal file
25
cpp/README.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# Cpp
|
||||
|
||||
```
|
||||
shaunrd0/klips/cpp/
|
||||
├── cmake # Example of using cmake to build and organize larger projects
|
||||
├── datastructs # Collection of useful datastructures written in C++
|
||||
├── opengl # Barebones opengl application written in C++ built with make
|
||||
├── README.md
|
||||
├── sdl # Barebones sdl application written in C++ built with make
|
||||
└── sdl-cmake # Barebones sdl application written in C++ built with cmake
|
||||
```
|
||||
|
||||
|
||||
In general, if a `CMakeLists.txt` is included in the project's root directory,
|
||||
we can build the example with the following commands
|
||||
|
||||
```
|
||||
mkdir build && cd build
|
||||
cmake .. && cmake --build .
|
||||
```
|
||||
|
||||
|
||||
If cmake is not being used in a project, it can be built with `g++` manually using
|
||||
the commands outlined in `*/.vscode/tasts.json`, or by using VSCode to open the example
|
||||
and running the build task.
|
||||
20
cpp/datastructs/README.md
Normal file
20
cpp/datastructs/README.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# Datastructs
|
||||
|
||||
A collection of useful datastructures written in C++. Examples of templating these
|
||||
structures in C++ can be found in the `templates/` directory.
|
||||
|
||||
```
|
||||
klips/cpp/datastructs
|
||||
.
|
||||
├── binarysearchtree # Binary search tree
|
||||
├── circledoublelist # Circular doubly linked list
|
||||
├── circlesinglelist # Circular singly linked list
|
||||
├── doublelist # Doubly linked list
|
||||
├── maxheap # Maximum heap
|
||||
├── queuelist # Queue implementation using linked list
|
||||
├── README.md
|
||||
├── singlelist # Singly linked list
|
||||
├── stacklist # Stack implementation using linked list
|
||||
├── templates # Templated data structures
|
||||
└── vector
|
||||
```
|
||||
14
cpp/datastructs/templates/README.md
Normal file
14
cpp/datastructs/templates/README.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# Datastructs
|
||||
|
||||
A collection of templated datastructures written in C++
|
||||
|
||||
```
|
||||
klips/cpp/datastructs/templates/
|
||||
.
|
||||
├── binarysearchtree # Templated binary search tree
|
||||
├── doublelist # Templated doubly linked list
|
||||
├── queuelist # Templated queue implementation using linked list
|
||||
├── README.md
|
||||
├── stacklist # Templated stack implementation using linked list
|
||||
└── vector # Templated custom vector implementation
|
||||
```
|
||||
Reference in New Issue
Block a user