https://github.com/twaritwaikar/wth-is-cpp

An experimental concept guide for C++ that works through code completions. [I don't maintain this anymore, this was a failed experiment]
https://github.com/twaritwaikar/wth-is-cpp

beginners-guide cpp guide

Last synced: 6 days ago
JSON representation

An experimental concept guide for C++ that works through code completions. [I don't maintain this anymore, this was a failed experiment]

• Host: GitHub
• URL: https://github.com/twaritwaikar/wth-is-cpp
• Owner: twaritwaikar
• License: mit
• Created: 2018-08-25T20:21:01.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-08-25T22:27:07.000Z (over 6 years ago)
• Last Synced: 2024-11-12T22:37:07.175Z (2 months ago)
• Topics: beginners-guide, cpp, guide
• Language: C++
• Homepage:
• Size: 6.84 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# What The Hell Is: C++

This project is an experimental concept I came up with as a user guide for C++.

The reader is supposed navigate the guide only through code completions provided by their text-editors/IDEs.

## How does this even work?

A better way to showcase the vision of this project would to provide with an example

For example the reader opened up `open_me_first.cpp`.

The reader writes:

```cpp

a_how_do_I_declare_variables

```

This invokes a macro that prints out the answer for the query.

The point of defining a macro like this is solely the fact that the reader knows that they can lookup beginner level guides using macros starting with `a_`.

All of these usage instructions will be added to the top of `open_me_first.cpp` for ease of reference.

This can be used to add all kinds of useful information. Maybe some easter eggs can also be added :P.

Unfortunately macros are not context aware, which means that we may need to overcome this shortcoming by using `#ifdef` directives inside macro definitions.

## SETUP instructions

These instructions are valid for both contributors and users of this manual.

1. Install [CMake](https://cmake.org/).

2. Clone this repository: `git clone https://github.com/IronicallySerious/wth-is-cpp`

3. Navigate to `wth-is-cpp/` and create a `build/` directory: `cd wth-is-cpp/ && mkdir build`

4. Run CMake: `cd build/ && cmake ..`

5. Execution instructions:

	1. For Linux users:

		1. Navigate to `build/`

		2. Build the project: `make`

		3. Run: `./wth-is-cpp`

	2. For Windows users:

		1. Open `Project.sln` from `wth-is-cpp/build` in Visual Studio (recommended for Intellisense suggestions)

		2. Right click on `wth-is-cpp` project and select `Select as StartUp Project`

		3. Press F5 to build and run.