docs: Update README
Release / check-release (push) Successful in 16s
Release / build_gnu (push) Skipped
Release / build_musl (push) Skipped
Release / build_windows (push) Skipped
Release / package_gnu (deb) (push) Skipped
Release / package_gnu (rpm) (push) Skipped
Release / package_musl (deb) (push) Skipped
Release / package_musl (rpm) (push) Skipped
Release / publish-release (push) Skipped
CI / Test (push) Successful in 1m35s
CI / Build Linux (push) Successful in 1m54s
Release / check-release (push) Successful in 16s
Release / build_gnu (push) Skipped
Release / build_musl (push) Skipped
Release / build_windows (push) Skipped
Release / package_gnu (deb) (push) Skipped
Release / package_gnu (rpm) (push) Skipped
Release / package_musl (deb) (push) Skipped
Release / package_musl (rpm) (push) Skipped
Release / publish-release (push) Skipped
CI / Test (push) Successful in 1m35s
CI / Build Linux (push) Successful in 1m54s
This commit is contained in:
+2
-1
@@ -1,4 +1,5 @@
|
||||
/target
|
||||
AGENT.md
|
||||
ARCHITECTURE.md
|
||||
Cargo.lock
|
||||
Cargo.lock
|
||||
examples
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "convertis"
|
||||
version = "0.1.0"
|
||||
version = "0.1.0-dev"
|
||||
edition = "2024"
|
||||
description = "A program attempting to be a universal file converter"
|
||||
repository = "https://git.ewenlau.net/ewenlau/convertis"
|
||||
|
||||
@@ -8,13 +8,29 @@ As it attemps to effectively cover an infinite number of possible conversions, i
|
||||
|
||||
## Installation
|
||||
|
||||
You may download a binary release from the releases page.
|
||||
Convertis can be installed in a few ways.
|
||||
|
||||
Crucially, the "gnu" builds target the GNU/Linux system whereas the "musl" builds target the musl C standard library. The "gnu" build is higly recommended, as the "musl" build is much less tested.
|
||||
Note: Convertis has three different targets "gnu", "musl" and "windows". The "gnu" build targets regular GNU/Linux systems, the "musl" build targets systems using the musl C standard library and the "windows" build targets windows systems. Only the "gnu" build is actively tested.
|
||||
|
||||
Additionally, .deb and .rpm packages are available for download, and can be installed using the system's package manager.
|
||||
### Via repository
|
||||
|
||||
A windows build is also available.
|
||||
Convertis is available on GNU/Linux for Debian-based systems and Fedora/CentOS-based systems via my gitea repository.
|
||||
|
||||
Packages are published for both the gnu and musl targets, although the gnu build should always be preferred.
|
||||
|
||||
See <https://git.ewenlau.net/ewenlau/convertis/packages> for options.
|
||||
|
||||
### Manual package install
|
||||
|
||||
You may download a .deb file for Debian-based systems and a .rpm file for Fedora/CentOS-based systems from the releases page. You can then install the package using your system's package manager.
|
||||
|
||||
See <https://git.ewenlau.net/ewenlau/convertis/releases>
|
||||
|
||||
### Binary download
|
||||
|
||||
If you use Windows, do not use a supported linux system or do not want to install any packages, you can download a binary release from the releases page.
|
||||
|
||||
See <https://git.ewenlau.net/ewenlau/convertis/releases>
|
||||
|
||||
## Building
|
||||
|
||||
|
||||
Reference in New Issue
Block a user