Skip to content

Commit 460ab86

Browse files
committed
revert README.md
1 parent f8bb51b commit 460ab86

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,20 @@ With this project, we want to provide an example and starting point for C++ proj
77
The project has initially been forked/copied from [Jason Turner's cpp_starter_project](https://github.com/lefticus/cpp_starter_project).
88

99

10+
<hr>
11+
## original README:
12+
13+
# cpp_starter_project
14+
15+
[![codecov](https://codecov.io/gh/lefticus/cpp_starter_project/branch/master/graph/badge.svg)](https://codecov.io/gh/lefticus/cpp_starter_project)
16+
17+
[![Build Status](https://travis-ci.org/lefticus/cpp_starter_project.svg?branch=master)](https://travis-ci.org/lefticus/cpp_starter_project)
18+
19+
[![Build status](https://ci.appveyor.com/api/projects/status/ro4lbfoa7n0sy74c/branch/master?svg=true)](https://ci.appveyor.com/project/lefticus/cpp-starter-project/branch/master)
20+
21+
![CMake](https://github.com/lefticus/cpp_starter_project/workflows/CMake/badge.svg)
22+
23+
1024
## Getting Started
1125

1226
### Use the Github template
@@ -213,6 +227,30 @@ The following compilers should work:
213227
https://github.com/include-what-you-use/include-what-you-use#how-to-install
214228
</details>
215229

230+
#### GUI libraries
231+
This project can be made to work with several optional GUI frameworks.
232+
233+
If desired, you should install the following optional dependencies as
234+
directed by their documentation, linked here:
235+
236+
- [FLTK](https://www.fltk.org/doc-1.4/index.html)
237+
- [GTKMM](https://www.gtkmm.org/en/documentation.html)
238+
- [QT](https://doc.qt.io/)
239+
240+
The following dependencies can be downloaded automatically by CMake and Conan.
241+
All you need to do to install them is to turn on a CMake flag during
242+
configuration.
243+
If you run into difficulty using them, please refer to their documentation,
244+
linked here:
245+
246+
- [NANA](http://nanapro.org/en-us/documentation/)
247+
- [SDL](http://wiki.libsdl.org/FrontPage)
248+
- [IMGUI](https://github.com/ocornut/imgui/tree/master/docs):
249+
This framework depends on SFML, and if you are using Linux, you may need
250+
to install several of SFML's dependencies using your package manager. See
251+
[the SFML build tutorial](https://www.sfml-dev.org/tutorials/2.5/compile-with-cmake.php)
252+
for specifics.
253+
216254
## Build Instructions
217255

218256
### Build directory

0 commit comments

Comments
 (0)