This commit is contained in:
parent
4d116c5fba
commit
942319e2df
26
README.md
26
README.md
@ -4,20 +4,16 @@
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/AparokshaUI/CodeEditor">
|
||||
GitHub
|
||||
<a href="https://codeeditor.apaorksha.dev/">
|
||||
Documentation
|
||||
</a>
|
||||
·
|
||||
<a href="Documentation/CodeEditor/README.md">
|
||||
CodeEditor Docs
|
||||
</a>
|
||||
·
|
||||
<a href="Documentation/CodeEditorFoundation/README.md">
|
||||
CodeEditorFoundation Docs
|
||||
<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://github.com/AparokshaUI/Adwaita).
|
||||
_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
|
||||
|
||||
@ -26,6 +22,10 @@ _CodeEditor_ adds support for text and code editors to GNOME apps built using [A
|
||||
- [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).
|
||||
|
||||
@ -34,22 +34,20 @@ Install `gtksourceview-devel` or similar (based on the package manager) as well
|
||||
2. Open the `Package.swift` file.
|
||||
3. Into the `Package` initializer, under `dependencies`, paste:
|
||||
```swift
|
||||
.package(url: "https://github.com/AparokshaUI/CodeEditor", from: "0.1.0")
|
||||
.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://github.com/AparokshaUI/Adwaita) packages.
|
||||
Check out the [Adwaita](https://git.aparoksha.dev/aparoksha/adwaita-swift) packages.
|
||||
|
||||
## Thanks
|
||||
|
||||
### Dependencies
|
||||
- [Adwaita](https://github.com/AparokshaUI/Adwaita) licensed under the [GPL-3.0 license](https://github.com/AparokshaUI/Adwaita/blob/main/LICENSE.md)
|
||||
- [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
|
||||
- The [contributors](Contributors.md)
|
||||
- [SwiftLint](https://github.com/realm/SwiftLint) for checking whether code style conventions are violated
|
||||
- The programming language [Swift](https://github.com/apple/swift)
|
||||
- [SourceDocs](https://github.com/SourceDocs/SourceDocs) used for generating the [docs](Documentation/Reference/README.md)
|
||||
- [GtkSourceView](https://gitlab.gnome.org/GNOME/gtksourceview/) for the widgets
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user