Mirrors/rink-rs
2
0
Fork 0
mirror of https://github.com/tiffany352/rink-rs synced 2024-09-20 06:01:59 +00:00
Code Issues Projects Releases Packages Wiki Activity
rink-rs/PACKAGING.md
Tiffany Bennett 6ce8d91b97
Dependencies cleanup (#163) 
- Set `default-features=false` where applicable
- Use specific num libraries instead of the top-level crate, as some
parts like complex numbers are not used.
- Replace reqwest with curl, which links the system libcurl and libssl
when possible.
- Add `opt-level="z"` and enable LTO for release builds.

All these changes combined, the CLI binary goes from 10.7 megabytes (or
8.7 manually stripped) to 5.4 megabytes.

The wasm binary is unaffected, still around 2.3 megabytes.
2024-03-31 14:34:09 -07:00

1.6 KiB
Raw Blame History

Distro Packaging

Requirements:

  • Rust compiler toolchain (stable build)
  • asciidoctor for building manpages
  • make

Additionally, if these libraries are present on the system, they will be used, otherwise they are statically linked:

  • libcurl
  • libssl (OpenSSL)

Rink requires several data files in order to work. By default these are baked into the binary so that cargo install will work, but for distro packaging these should probably go into /usr/share instead. The makefile will do this automatically.

Makefile-based method

make fetch
make all prefix=/usr
make install prefix=/usr DESTDIR=$pkgdir

A makefile is provided for easier packaging.

Running make all will build both the program and the man pages, and make install will install them.

Note that the makefile accepts both the prefix and DESTDIR arguments. prefix is where Rink should look for its files, this should generally be /usr. DESTDIR is where the files will be copied to upon running make install.

Manual packaging

Build the program using cargo. The RINK_PATH environment variable can be set to something like /usr/share/rink so that rink will look in this directory for its files. Passing --no-default-features will turn off rink bundling the files into its executable file.

Build the manpages in docs/ using asciidoctor.

  1. Install target/release/rink -> /usr/bin/rink.
  2. Install core/definitions.units -> /usr/share/rink/definitions.units.
  3. Install core/currency.units -> /usr/share/rink/currency.units.
  4. Install datepatterns.txt -> /usr/share/rink/datepatterns.txt.
  5. Install the manpages into the relevant directories.