aparoksha/codeeditor
1
0
Fork 0
Code Issues Pull Requests Actions Releases Activity

Update README
Some checks failed
Deploy Docs / publish (push) Failing after 10s
Details

Browse Source
This commit is contained in:
david-swift 2025-04-15 16:56:00 +02:00
parent 4d116c5fba
commit 942319e2df
1 changed files with 12 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -4,20 +4,16 @@
</p> </p>
<p align="center"> <p align="center">
<a href="https://github.com/AparokshaUI/CodeEditor"> <a href="https://codeeditor.apaorksha.dev/">
GitHub Documentation
</a> </a>
· ·
<a href="Documentation/CodeEditor/README.md"> <a href="https://git.aparoksha.dev/aparoksha/codeeditor">
CodeEditor Docs Code
</a>
·
<a href="Documentation/CodeEditorFoundation/README.md">
CodeEditorFoundation Docs
</a> </a>
</p> </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 ## Table of Contents
@ -26,6 +22,10 @@ _CodeEditor_ adds support for text and code editors to GNOME apps built using [A
- [Thanks](#Thanks) - [Thanks](#Thanks)
## Installation ## Installation
### Flatpak
If you use Flatpak to develop your application, copy the manifest `dev.aparoksha.Demo.json`.
There is no further installation required.
### Dependencies ### Dependencies
Install `gtksourceview-devel` or similar (based on the package manager) as well as `gtk4-devel` and `libadwaita-devel` (or similar). 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. 2. Open the `Package.swift` file.
3. Into the `Package` initializer, under `dependencies`, paste: 3. Into the `Package` initializer, under `dependencies`, paste:
```swift ```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 ## Usage
Take a look at the simple [sample app](Tests/main.swift). 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 ## Thanks
### Dependencies ### 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 ### Other Thanks
- The [contributors](Contributors.md)
- [SwiftLint](https://github.com/realm/SwiftLint) for checking whether code style conventions are violated - [SwiftLint](https://github.com/realm/SwiftLint) for checking whether code style conventions are violated
- The programming language [Swift](https://github.com/apple/swift) - 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 - [GtkSourceView](https://gitlab.gnome.org/GNOME/gtksourceview/) for the widgets