From 63fda939de32918685fe9191a791cf6b314b0a47 Mon Sep 17 00:00:00 2001 From: Heng Li Date: Mon, 22 Mar 2021 19:36:12 -0400 Subject: [PATCH] more details; to add v1.0 --- README.md | 31 +++++++++++++++++++------------ 1 file changed, 19 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index bb06748..fbc75d3 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,31 @@ -[Crystal][crystal] is a young compiled programming language that is similar to Ruby in -syntax but is much faster. It is non-trivial to install Crystal without the -root permision. Although you can find precompiled binary packages from Crystal's -release page, those packages lack essential libraries required to -compile any Crystal programs. As a result, users have to install additional -packages to make Crystal work. +[Crystal][crystal] is a young compiled programming language that is similar to +Ruby in syntax but is much faster. It is non-trivial to install Crystal without +the root permision. Although you can find precompiled binary packages from +[Crystal's release page][crrel], those packages lack essential libraries +required to compile any Crystal programs. As a result, users have to install +additional packages to make Crystal work. This repository provides portable precompiled Crystal binaries. The only difference from the official packages is that pacakges here include static -[libevent][libev] and [PCRE][pcre] libraries. Users can download a package from -the [release page][rel], unpack it and run +[libevent][libev] and [PCRE][pcre] libraries available in +[crystal-libs-v1.tar.bz2][libs] from this repo. To use PortableCrystal, users +can download a package from the [release page][rel], unpack it and run `crystal-verion_x64-linux/bin/crystal` to compile their programs without -installing other libraries. **More importantly**, executables -compiled with our binary distributions are not dynamically linked to the two -libraries and are thus more portable -- as developers, we wouldn't want our -users to install other libraries to use our tools. +installing other libraries. **More importantly**, executables compiled with our +binary distributions are not dynamically linked to the two libraries and are +thus more portable -- as developers, we wouldn't want our users to install +other libraries to use our tools. At present, this repository does not provide libyaml and libgmp which are required to compile certain crystal programs. +Available verions: [0.34.0][v0.34.0] and [1.0][v1.0]. + [crystal]: https://crystal-lang.org/ [libev]: https://libevent.org/ [pcre]: https://www.pcre.org/ [rel]: https://github.com/lh3/PortableCrystal/releases +[crrel]: https://github.com/crystal-lang/crystal/releases +[libs]: https://github.com/lh3/PortableCrystal/releases/download/dummy/crystal-libs-v1.tar.bz2 +[v0.34.0]: https://github.com/lh3/PortableCrystal/releases/tag/dummy +[v1.0]: https://github.com/lh3/PortableCrystal/releases/tag/v1.0