You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-51Lines changed: 15 additions & 51 deletions
Original file line number
Diff line number
Diff line change
@@ -28,14 +28,10 @@
28
28
-[Related projects](#related-projects)
29
29
-[Design references](#design-references)
30
30
-[Quick start](#quick-start)
31
-
-[Windows](#windows)
32
-
- [Create new LCUI project](#create-new-lcui-project)
33
-
- [Install LCUI for existing project](#install-lcui-for-existing-project)
34
-
- [Manual compilation and installation](#manual-compilation-and-installation)
35
-
-[Ubuntu](#ubuntu)
36
-
-[Roadmap](#roadmap)
37
-
-[Primary Roadmap](#primary-roadmap)
38
-
-[Secondary Roadmap](#secondary-roadmap)
31
+
-[Use LCUI CLI](#use-lcui-cli)
32
+
-[Manual compilation and installation](#manual-compilation-and-installation)
33
+
-[Windows](#windows)
34
+
-[Ubuntu](#ubuntu)
39
35
-[Contribution](#contribution)
40
36
-[Documentation](#documentation)
41
37
-[FAQ](#faq)
@@ -111,11 +107,9 @@ Want to know what LCUI can do? You can view the following projects:
111
107
112
108
## Quick start
113
109
114
-
### Windows
110
+
### Use LCUI CLI
115
111
116
-
#### Create new LCUI project
117
-
118
-
Quickly create an LCUI project using [lcui-cli](https://github.com/lc-ui/lcui-cli):
112
+
LCUI CLI is a command line tool, you need to install [Node.js](https://nodejs.org/) before using it, and then run the following command to quickly experience it:
119
113
120
114
```bash
121
115
# Install lcui-cli and lcpkg
@@ -127,30 +121,19 @@ lcui create myapp
127
121
# Go into project directory
128
122
cd myapp
129
123
130
-
# Install dependencies
131
-
lcpkg install
132
-
133
-
# Run it
134
-
lcpkg run start
135
-
```
136
-
137
-
#### Install LCUI for existing project
124
+
# set up the development environment for this project
125
+
lcui setup
138
126
139
-
Use [lcpkg](https://github.com/lc-soft/lcpkg) to quick install LCUI in your project directory:
127
+
# Build project
128
+
lcui build
140
129
141
-
```bash
142
-
# Initialize the lcpkg configuration file to tell lcpkg about your project
143
-
lcpkg init
144
-
145
-
# Download and install the compiled LCUI library from GitHub
146
-
lcpkg install github.com/lc-soft/LCUI
130
+
# run project
131
+
lcui run
147
132
```
148
133
149
-
After successful installation, follow the help documentation output by lcpkg to configure your project's build configuration.
150
-
151
-
#### Manual compilation and installation
134
+
### Manual compilation and installation
152
135
153
-
If you want to manually compile LCUI from source code:
136
+
#### Windows
154
137
155
138
1. Open CMD window, and run following command in the LCUI source directory to install the dependency libraries:
156
139
```bash
@@ -164,7 +147,7 @@ If you want to manually compile LCUI from source code:
164
147
1. Rename `config.win32.h.in`in the include directory to `config.h`.
165
148
1. Open the `build/windows/LCUI.sln` file with [Visual Studio](https://visualstudio.microsoft.com/), and then build LCUI.
166
149
167
-
### Ubuntu
150
+
#### Ubuntu
168
151
169
152
```bash
170
153
# Install the dependencies
@@ -197,25 +180,6 @@ cd test
197
180
198
181
>**Note:** If you want to customize the compiler, compile flags, install location, and other configuration items, read the [INSTALL](INSTALL) file.
199
182
200
-
## Roadmap
201
-
202
-
The roadmap for this project is divided into primary and secondary roadmaps, with the primary roadmap developed by the project maintainer and the secondary roadmap developed by the open source community contributors and developers like you.
203
-
204
-
### Primary Roadmap
205
-
206
-
- Make project code more standardized, readable, and maintainable
207
-
- Improve relevant development tools and sample applications to improve the development efficiency and make it easier to use
208
-
209
-
### Secondary Roadmap
210
-
211
-
- Explore new GUI development methods to make LCUI unique
212
-
- [Accessbility](https://developer.mozilla.org/en-US/docs/Learn/Accessibility/What_is_accessibility) support
213
-
- Research [SDL](https://github.com/SDL-mirror/SDL), [imgui](https://github.com/ocornut/imgui) and other similar open source projects, and try to fill in what LCUI is missing
214
-
- Refactor the existing graphics processing interface to make it easy to integrate with mainstream 2D graphics libraries and bring better graphics rendering performance to LCUI
215
-
- Add driver support for Mac OS, Android and iOS
216
-
- Add more mouse cursor styles
217
-
- Add clipboard support
218
-
219
183
## Contribution
220
184
221
185
Think LCUI is slow to update? there are many ways to [contribute](.github/CONTRIBUTING.md) to LCUI.
0 commit comments