Compare commits

...

2 commits

6 changed files with 100 additions and 30 deletions

11
AUTHORS
View file

@ -1,11 +0,0 @@
Author:
Dakshinamurthy Karra (dakshinamurthy.karra@gmail.com)
Maintainer:
Dakshinamurthy Karra (dakshinamurthy.karra@gmail.com)
Source Contributions:
+ others listed in the ChangeLog
Thanks:
The original xosd program!!

7
AUTHORS.md Normal file
View file

@ -0,0 +1,7 @@
## Contributors:
- Dakshinamurthy Karra <dakshinamurthy.karra@gmail.com>
- Razzaline Reindell <razzaline@noreply@alteria.xyz>
- Rose <rose@noreply@alteria.xyz>
## Thanks:
The original XOSD program!!

View file

@ -1,21 +1,46 @@
# Changelog # Changelog
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), The format is based on [Common Changelog](https://common-changelog.org/)
and [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased] ## [2.0.0] - 2023-10-31
### Changed
- **Breaking:** Set text and shadow alpha independently from background alpha. ([#2](https://codelabs.alteria.xyz/rosethorn/libxosd-xft/issues/2)) ([Razzaline](https://codelabs.alteria.xyz/razzaline))
- **Breaking:** Set shadow X and Y offset independently. ([#3](https://codelabs.alteria.xyz/rosethorn/libxosd-xft/issues/3)) ([Razzaline](https://codelabs.alteria.xyz/razzaline))
- **Breaking:** Rename `alpha` in [intern.h](https://codelabs.alteria.xyz/rosethorn/libxosd-xft/src/branch/main/src/libxosd-xft/intern.h) to `bg_alpha`
- **Breaking:** Rename `color` in [intern.h](https://codelabs.alteria.xyz/rosethorn/libxosd-xft/src/branch/main/src/libxosd-xft/intern.h) to `text_color`
### Added
- Change Installation section in readme to Building and Installing, and expand it to include instructions for Arch-, Debian-, and RPM-based systems. ([Razzaline](https://codelabs.alteria.xyz/razzaline), [Rose](https://codelabs.alteria.xyz/rosethorn))
- Add `git`, `autoconf`, and `automake` to PKGBUILD ([Rose](https://codelabs.alteria.xyz/rosethorn)
### Fixed
- Display `delay-in-milliseconds` option in `osd-cat` and `osd-echo` help messages ([#1](https://codelabs.alteria.xyz/rosethorn/libxosd-xft/issues/1)) ([Rose](https://codelabs.alteria.xyz/rosethorn))
- Correct `osd-cat` example in readme and rename remaining reference of `osd-showfile` to `osd-cat` ([`dd8dc6a927`](https://codelabs.alteria.xyz/rosethorn/libxosd-xft/commit/dd8dc6a9274b0ff05249290eafec80c7c861aa13), [`c6a0ec832a`](https://codelabs.alteria.xyz/rosethorn/libxosd-xft/commit/c6a0ec832a59adbb653cff23fdd8ab7250e66ce7)) ([Rose](https://codelabs.alteria.xyz/rosethorn), [Razzaline](https://codelabs.alteria.xyz/razzaline))
## [1.1.0] - 2021-07-05 ## [1.1.0] - 2021-07-05
Changed the command names to osd-cat and osd-echo ### Changed
- Changed the command names to `osd-cat` and `osd-echo`
## [1.0.1] - 2021-06-21 ## [1.0.1] - 2021-06-21
Added PKGBUILD to build from github repository. ### Added
- Added PKGBUILD to build an Arch package from the repository.
## [1.0.0] - 2021-06-21 ## [1.0.0] - 2021-06-21
Initial public release Initial public release
[2.0.0]: https://rose.codelabs.alteria.xyz/rosethorn/libxosd-xft/compare/v1.1.0...v2.0.0
[1.1.0]: https://rose.codelabs.alteria.xyz/rosethorn/libxosd-xft/compare/v1.0.1...v1.1.0
[1.0.1]: https://rose.codelabs.alteria.xyz/rosethorn/libxosd-xft/compare/v1.0.0...v1.0.1
[1.0.0]: https://rose.codelabs.alteria.xyz/rosethorn/libxosd-xft/releases/tag/v1.0.0

View file

@ -5,34 +5,82 @@ Inspired by [libxosd](https://sourceforge.net/projects/libxosd/).
`xosd-xft` supports: `xosd-xft` supports:
* Use of Xft/TTF fonts * Use of Xft/TTF fonts
* Xrandr and Xinerama extensions * XRandR and Xinerama extensions
* Allows you to choose a monitor in multihead setups - including active monitor * Allows you to choose a monitor in multihead setups - including active monitor
* Use `osd-echo` to display a [Nerd Font](https://nerdfonts.com) glyph * Use `osd-echo` to display a [Nerd Font](https://nerdfonts.com) glyph
* Use `osd-cat` to display a file * Use `osd-cat` to display a file
# Installation ---
# Building and Installing
GNU Autotools is required for building.
## Arch
To build a package, run this command in the directory containing the PKGBUILD:
```sh
makepkg --syncdeps --install
```
## Manual installation ## Manual installation
```bash
Instructions may vary depending on your system, but this is a general guideline.
### Installing required packages on Arch-based systems (including Manjaro)
Required dependencies for building:
```sh
sudo pacman -S libxt libxft libxext xorg-util-macros
```
For building with XRandR and Xinerama extensions:
```sh
sudo pacman -S libxrandr libxinerama
```
### Installing required packages on Debian-based systems (including Ubuntu and Linux Mint)
Required packages for building:
```sh
sudo apt-get install libxt-dev libxft-dev libxext-dev xutils-dev
```
XRandR and Xinerama extensions:
```sh
sudo apt-get install libxrandr-dev libxinerama-dev
```
### Installing required packages on RPM-based systems (including Fedora and CentOS)
Required packages for building:
```sh
dnf install libXt-devel libXft-devel libXext-devel xorg-x11-util-macros
```
XRandR and Xinerama extensions:
```sh
dnf install libXrandr libXinerama
```
### Building
From the source directory:
```sh
./autobuild.sh ./autobuild.sh
./configure ./configure
make -j$(nproc) make -j$(nproc)
sudo make install sudo make install
``` ```
## Arch ---
From the directory containing the PKGBUILD:
```bash
makepkg --syncdeps --install
```
# Quick Look # Brief Examples
## Using osd-echo ## Using osd-echo
To display volume off glyph and execute `amixer` command: To display volume off glyph and execute `amixer` command:
```bash ```sh
osd-echo -e 'amixer set Master off' :fa-volume_off: osd-echo -e 'amixer set Master off' :fa-volume_off:
``` ```

View file

@ -4,17 +4,17 @@ pkgname=xosd-xft-git
_pkgname=${pkgname%-git} _pkgname=${pkgname%-git}
pkgver=1.1.0.r1.gdd8dc6a pkgver=1.1.0.r1.gdd8dc6a
pkgrel=1 pkgrel=1
pkgdesc="Inspired by libxosd, with XFT support" pkgdesc="An on-screen display library inspired by libxosd, with XFT support"
arch=(x86_64) arch=(x86_64)
url="https://codelabs.alteria.xyz/rosethorn/libxosd-xft" url="https://codelabs.alteria.xyz/rosethorn/libxosd-xft"
license=('GPL3' 'LGPL3') license=('GPL3' 'LGPL3')
depends=('libxt' 'libxft' 'libxext') depends=('libxt' 'libxft' 'libxext')
makedepends=('xorg-util-macros') makedepends=('git' 'xorg-util-macros' 'autoconf' 'automake')
optdepends=('libxrandr: Xrandr multihead support' optdepends=('libxrandr: Xrandr multihead support'
'libxinerama: Xinerama multihead support') 'libxinerama: Xinerama multihead support')
provides=($_pkgname) provides=($_pkgname)
conflicts=($_pkgname) conflicts=($_pkgname)
source=("$_pkgname::git+${url}.git") source=("$_pkgname::git+${url}")
md5sums=('SKIP') md5sums=('SKIP')
pkgver() { pkgver() {
@ -23,7 +23,7 @@ pkgver() {
} }
build() { build() {
cd "${srcdir}/${_pkgname}" cd "${_pkgname}"
./autobuild.sh ./autobuild.sh
./configure --prefix=/usr ./configure --prefix=/usr
make -j$(nproc) make -j$(nproc)

View file

@ -1,4 +1,5 @@
libtoolize && \ libtoolize && \
autoreconf --install && \
aclocal && \ aclocal && \
automake --add-missing && autoconf automake --add-missing && autoconf