Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typo and add important include #173

Merged
merged 4 commits into from
Jul 15, 2019
+15 −6
Merged

Fix typo and add important include #173

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9b5243a
Fix typo in the "building" section
Jul 13, 2019
83d6938
include LCUI_Build.h in LCUI/LCUI.h to avoid lots of errors I had whe…
Jul 13, 2019
6e45d25
changed: include headers to integrate the changes by lc-soft
Jul 15, 2019
c95703d
added: newline at end of "include/LCUI.h"
Jul 15, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -19,11 +19,18 @@

## Table of contents

- [Introduction](#introduction)
- [License](#license)
- [Documentation](#documentation)
- [Building](#building)
- [Contribution](#contribution)
- [Table of contents](#Table-of-contents)
- [Introduction](#Introduction)
- [Features](#Features)
- [Missing features](#Missing-features)
- [Related Projects](#Related-Projects)
- [Documentation](#Documentation)
- [Building](#Building)
- [Prerequisites](#Prerequisites)
- [Building On Windows](#Building-On-Windows)
- [Bootstrap](#Bootstrap)
- [Contribution](#Contribution)
- [License](#License)

## Introduction

@@ -119,7 +126,7 @@ If you want to experience the demo, please run:

cd test
make
./hellowrold
./helloworld

If you want to use custom building options, please read the [INSTALL](INSTALL) file for more details.

1 change: 1 addition & 0 deletions include/LCUI/LCUI.h
View file
Original file line number Diff line number Diff line change
@@ -32,6 +32,7 @@
#ifndef LCUI_H
#define LCUI_H

#include <LCUI_Build.h>
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add "#include <LCUI_Build.h>" to "include/LCUI.h" to avoid issues when include order is wrong

LCUI_Build.h should always be the first one to be included, I think LCUI.h does not need to be modified.

I have the following improvements, how do you feel?

files:

+ include/LCUI.h

include/LCUI.h：

#include <LCUI_Build.h>
#include <LCUI/LCUI.h>

After this modification, we can include the header file in a new way:

- #include <LCUI_Build.h>
- #include <LCUI/LCUI.h>
+#include <LCUI.h>

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That seems like a good idea. Similar to how windows handles all important includes with Windows.h

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@toluschr Ok, since you and I agree with these improvements, please replace your current changes with the above.

#include <LCUI/types.h>
#include <LCUI/util.h>
#include <LCUI/main.h>