Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PeterMortensen authored Jan 1, 2020
1 parent d713053 commit e0cfb33
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Qt Code Editor Widget
It's widget for editing/viewing code.
It's a widget for editing/viewing code.

This project uses resource named `qcodeeditor_resources.qrc`. Main application
must not use resource file with the same name.
This project uses a resource named `qcodeeditor_resources.qrc`. The main application
must not use a resource file with the same name.

(It's not project from Qt example)
(It's not a project from a Qt example.)

## Requirements
0. C++11 featured compiler.
Expand All @@ -24,22 +24,22 @@ must not use resource file with the same name.
1. Qt Creator styles.

## Build
It's CMake based library so it can be used as submodule. (See example)
But here is the steps to build it as static library (for external use for example).
It's a CMake-based library, so it can be used as a submodule (see the example).
But here are the steps to build it as a static library (for external use for example).

1. Clone repo: `git clone https://github.com/Megaxela/QCodeEditor`
1. Go into repo: `cd QCodeEditor`
1. Create build folder: `mkdir build`
1. Go into build folder: `cd build`
1. Generate build file for your compiler: `cmake ..`
1. If you need to build example, specify `-DBUILD_EXAMPLE=On` on this step.
1. Build library: `cmake --build .`
1. Clone the repository: `git clone https://github.com/Megaxela/QCodeEditor`
1. Go into the repository: `cd QCodeEditor`
1. Create a build folder: `mkdir build`
1. Go into the build folder: `cd build`
1. Generate a build file for your compiler: `cmake ..`
1. If you need to build the example, specify `-DBUILD_EXAMPLE=On` on this step.
1. Build the library: `cmake --build .`

## Example

By default `QCodeEditor` uses standard QtCreator theme. But you may specify
you own by parsing it with `QSyntaxStyle`. Example uses [Dracula](https://draculatheme.com) theme.
(See example for more)
By default, `QCodeEditor` uses the standard QtCreator theme. But you may specify
your own by parsing it with `QSyntaxStyle`. The example uses [Dracula](https://draculatheme.com) theme.
(See the example for more.)

<img src="https://github.com/Megaxela/QCodeEditor/blob/master/example/image/preview.png">

Expand All @@ -65,4 +65,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.

0 comments on commit e0cfb33

Please sign in to comment.