Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lucasstarsz/compose
A JavaFX-based text editor.
https://github.com/lucasstarsz/compose
java javafx text-editor
Last synced: 4 days ago
JSON representation
A JavaFX-based text editor.
- Host: GitHub
- URL: https://github.com/lucasstarsz/compose
- Owner: lucasstarsz
- License: mit
- Created: 2021-01-17T03:37:19.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-05-06T19:08:58.000Z (over 2 years ago)
- Last Synced: 2023-03-06T02:39:13.498Z (over 1 year ago)
- Topics: java, javafx, text-editor
- Language: Java
- Homepage:
- Size: 952 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Compose
### Because Notepad wasn't enough.
[![Windows Build Status][Windows-Build-SVG]][Windows-Build-Action]
[![Ubuntu Build Status][Ubuntu-Build-SVG]][Ubuntu-Build-Action]
[![Mac OS Build Status][MacOS-Build-SVG]][MacOS-Build-Action]
**[Download][Download Link] • [Changelog][Changelog link]**
## About Compose
Compose is a text editor written in Java, specifically [JavaFX][JavaFX-Link]. It serves as a text editor to help you keep your note-taking in check.
## Highlights
### Pleasant Theming
With color appeal on the rise, Compose came prepared with themes -- more are on the way!
#### Darc Theme
#### Light Theme
#### Fresh Theme
### Configurable Settings
Easily change the text wrap, font, font size, and theme -- Compose auto-magically saves your settings for you to come back later.
## Building the Source Code
1. If you don't already have it, download [Git][Git-Link]. It's a powerful source control tool, and is the same source control that Compose uses.
- You don't need to have Gradle installed to build Compose -- Gradle projects come with the build tool specialized for the project already.
2. Using Git, clone the Compose repository.
```bash
git clone https://github.com/lucasstarsz/Compose.git
```
3. Once you've entered the top directory of the project (`cd Compose`), build the project using the `gradlew` file.
- On Windows, you'll want to use the `gradlew.bat` file.
- On Unix-based systems (macOS, Linux), you'll need to use the `gradlew.sh` file (after giving it proper execution permissions).
```bash
./gradlew build
```
_Having trouble accessing the `gradlew` file? Read [this][Terminals Are Different]._
## Legal Information
This repository is licensed under the [MIT License][MIT-License].
[Windows-Build-Action]: https://github.com/lucasstarsz/Compose/actions?query=workflow%3ABuild-Windows "Windows Build Status"
[Windows-Build-SVG]: https://img.shields.io/github/workflow/status/lucasstarsz/Compose/Build-Windows?label=Windows%20Build&labelColor=363e45&logo=windows&logoColor=0078D6&style=for-the-badge
[Ubuntu-Build-Action]: https://github.com/lucasstarsz/Compose/actions?query=workflow%3ABuild-Ubuntu "Ubuntu Build Status"
[Ubuntu-Build-SVG]: https://img.shields.io/github/workflow/status/lucasstarsz/Compose/Build-Ubuntu?label=Ubuntu%20Build&labelColor=363e45&logo=ubuntu&logoColor=E95420&style=for-the-badge
[MacOS-Build-Action]: https://github.com/lucasstarsz/Compose/actions?query=workflow%3ABuild-MacOS "Mac OS Build Status"
[MacOS-Build-SVG]: https://img.shields.io/github/workflow/status/lucasstarsz/Compose/Build-MacOS?label=Mac%20OS%20Build&labelColor=363e45&logo=apple&logoColor=000000&style=for-the-badge
[Download Link]: https://github.com/lucasstarsz/Compose/releases "Downloads"
[Changelog Link]: https://github.com/lucasstarsz/Compose/releases/tree/main/changelog.md "Changelog"
[JavaFX-Link]: https://openjfx.io "JavaFX"
[Terminals Are Different]: https://gist.github.com/lucasstarsz/9bbc306f8655b916367d557043e498ad "Terminals Access Files Differently"
[Git-Link]: https://git-scm.com/ "Git Source Control Manager"
[MIT-License]: LICENSE.txt "MIT License"