diff --git a/CHANGELOG.md b/CHANGELOG.md index ebb62b4..272dc30 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +### Added + +- Pre-built binaries for x86_64-linux and aarch64-linux + ## [0.1.0] - 2022-02-14 ### Added diff --git a/README.md b/README.md index e3a42cd..30199ee 100644 --- a/README.md +++ b/README.md @@ -94,9 +94,41 @@ ## Getting started -Let's get Alejandra on our systems: +### On the web editor -- Nix with Flakes: +Please visit: +[kamadorueda.github.io/alejandra](https://kamadorueda.github.io/alejandra/) + +### Prebuilt binaries + +Requirements: +[curl](https://curl.se/), +[sh](https://www.gnu.org/software/bash/) and +[chmod](https://www.gnu.org/software/coreutils/). + +Steps: + +- On any x86_64 Linux: + + ```bash + $ curl https://raw.githubusercontent.com/kamadorueda/alejandra/main/installers/x86_64-linux.sh | sh + ``` + +- On any AArch64/ARM64 Linux: + + ```bash + $ curl https://raw.githubusercontent.com/kamadorueda/alejandra/main/installers/aarch64-linux.sh | sh + ``` + +Then run Alejandra with: + +```bash +$ alejandra --help +``` + +### Nix installation + +- Nix with [Flakes](https://nixos.wiki/wiki/Flakes): ```bash $ nix profile install github:kamadorueda/alejandra @@ -113,7 +145,7 @@ Let's get Alejandra on our systems: $ nix-env -ivA x86_64-linux -f https://github.com/kamadorueda/alejandra/tarball/main ``` -Then run with: +Then run Alejandra with: ```bash $ alejandra --help @@ -152,6 +184,10 @@ Our public API consists of: positional arguments, and stdout. +## Changelog + +Please see: [CHANGELOG.md](./CHANGELOG.md). + ## Footnotes [^benchmark-specs]: diff --git a/buildkite.yaml b/buildkite.yaml index 118fd27..d1c2d80 100644 --- a/buildkite.yaml +++ b/buildkite.yaml @@ -8,8 +8,22 @@ steps: agents: queue: private artifacts: + # Builds on: aarch64-darwin + # - aarch64-apple-darwin + + # Builds on: aarch64-linux + # - aarch64-unknown-linux-musl + + # Builds on: x86_64-linux - alejandra-aarch64-unknown-linux-musl + + # Builds on: x86_64-darwin + # - alejandra-x86_64-apple-darwin + + # Builds on: x86_64-linux - alejandra-x86_64-unknown-linux-gnu + + # Builds on: x86_64-linux - alejandra-x86_64-unknown-linux-musl command: - echo +++ diff --git a/installers/aarch64-linux.sh b/installers/aarch64-linux.sh new file mode 100755 index 0000000..9839f7a --- /dev/null +++ b/installers/aarch64-linux.sh @@ -0,0 +1,9 @@ +#! /bin/sh + +releases=https://github.com/kamadorueda/alejandra/releases/download/ +target=alejandra-aarch64-unknown-linux-musl +version=0.1.0 + +curl -o alejandra -L "${releases}/${version}/${target}" + +chmod +x alejandra diff --git a/installers/x86_64-linux.sh b/installers/x86_64-linux.sh new file mode 100755 index 0000000..82aa66f --- /dev/null +++ b/installers/x86_64-linux.sh @@ -0,0 +1,9 @@ +#! /bin/sh + +releases=https://github.com/kamadorueda/alejandra/releases/download/ +target=alejandra-x86_64-unknown-linux-musl +version=0.1.0 + +curl -o alejandra -L "${releases}/${version}/${target}" + +chmod +x alejandra