54 lines
1.7 KiB
Markdown
54 lines
1.7 KiB
Markdown
<p align="center">
|
|
<img width="256" alt="CodeEditor Icon" src="Icons/CodeEditorIcon.png">
|
|
<h1 align="center">CodeEditor</h1>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://codeeditor.aparoksha.dev/">
|
|
Documentation
|
|
</a>
|
|
·
|
|
<a href="https://git.aparoksha.dev/aparoksha/codeeditor">
|
|
Code
|
|
</a>
|
|
</p>
|
|
|
|
_CodeEditor_ adds support for text and code editors to GNOME apps built using [Adwaita for Swift](https://git.aparoksha.dev/aparoksha/adwaita-swift).
|
|
|
|
## Table of Contents
|
|
|
|
- [Installation](#Installation)
|
|
- [Usage](#Usage)
|
|
- [Thanks](#Thanks)
|
|
|
|
## Installation
|
|
### Flatpak
|
|
If you use Flatpak to develop your application, copy the manifest `dev.aparoksha.Demo.json`.
|
|
There is no further installation required.
|
|
|
|
### Dependencies
|
|
Install `gtksourceview-devel` or similar (based on the package manager) as well as `gtk4-devel` and `libadwaita-devel` (or similar).
|
|
|
|
### Swift Package
|
|
1. Open your Swift package in GNOME Builder, or any other IDE.
|
|
2. Open the `Package.swift` file.
|
|
3. Into the `Package` initializer, under `dependencies`, paste:
|
|
```swift
|
|
.package(url: "https://git.aparoksha.dev/aparoksha/codeeditor", from: "0.1.0")
|
|
```
|
|
|
|
## Usage
|
|
|
|
Take a look at the simple [sample app](Tests/main.swift).
|
|
Check out the [Adwaita](https://git.aparoksha.dev/aparoksha/adwaita-swift) packages.
|
|
|
|
## Thanks
|
|
|
|
### Dependencies
|
|
- [Adwaita](https://git.aparoksha.dev/aparoksha/adwaita-swift) licensed under the [MIT license](https://git.aparoksha.dev/aparoksha/adwaita-swift/src/branch/main/LICENSE.md)
|
|
|
|
### Other Thanks
|
|
- [SwiftLint](https://github.com/realm/SwiftLint) for checking whether code style conventions are violated
|
|
- The programming language [Swift](https://github.com/apple/swift)
|
|
- [GtkSourceView](https://gitlab.gnome.org/GNOME/gtksourceview/) for the widgets
|