Skip to content

Commit a05f06d

Browse files
author
Jonathan D.A. Jewell
committed
Align README with asdf-ada structure
1 parent 3caa441 commit a05f06d

File tree

1 file changed

+162
-0
lines changed

1 file changed

+162
-0
lines changed

README.adoc

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
= asdf-rescript
2+
:toc: macro
3+
:toclevels: 3
4+
:icons: font
5+
:source-highlighter: rouge
6+
:experimental:
7+
:author: hyperpolymath
8+
:revnumber: 0.1.0
9+
:url-asdf: https://asdf-vm.com
10+
:url-tool: https://img.shields.io/badge/license-PMPL--1.0-blue.svg[License,link=
11+
:url-repo: https://github.com/hyperpolymath/asdf-rescript-plugin
12+
13+
image:https://img.shields.io/badge/license-PMPL--1.0-blue.svg[License,link="https://github.com/hyperpolymath/palimpsest-license"]
14+
image:https://img.shields.io/badge/Philosophy-Palimpsest-1f6feb.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-license"]
15+
image:https://img.shields.io/github/license/hyperpolymath/asdf-rescript-plugin?style=flat-square[License,link=LICENSE]
16+
image:https://img.shields.io/github/v/release/hyperpolymath/asdf-rescript-plugin?style=flat-square[Release,link={url-repo}/releases]
17+
image:https://img.shields.io/github/actions/workflow/status/hyperpolymath/asdf-rescript-plugin/ci.yml?branch=main&style=flat-square[Build Status,link={url-repo}/actions]
18+
image:https://img.shields.io/badge/asdf-plugin-blue?style=flat-square[asdf Plugin,link={url-asdf}]
19+
20+
[.lead]
21+
An {url-asdf}[asdf] plugin to install and manage {url-tool}[Rescript] versions.
22+
23+
toc::[]
24+
25+
== Overview
26+
27+
=== What is Rescript?
28+
29+
Rescript is an upstream tool managed by this plugin. Refer to the official
30+
project documentation for details on usage and capabilities.
31+
32+
=== What is asdf?
33+
34+
{url-asdf}[asdf] is a universal version manager that allows you to manage
35+
multiple runtime versions with a single CLI tool.
36+
37+
=== Why asdf-rescript?
38+
39+
[cols="1,3"]
40+
|===
41+
|Feature |Benefit
42+
43+
|**Version Switching**
44+
|Switch between Rescript versions per project
45+
46+
|**Project Isolation**
47+
|Pin Rescript per repository via `.tool-versions`
48+
49+
|**Reproducible Builds**
50+
|Align CI/CD and developer environments to the same Rescript version
51+
52+
|**Cross-Platform**
53+
|Works on Linux and macOS, with Windows via WSL
54+
|===
55+
56+
== Prerequisites
57+
58+
=== System Requirements
59+
60+
[cols="1,2,3"]
61+
|===
62+
|Platform |Minimum Version |Notes
63+
64+
|**Linux**
65+
|Ubuntu 20.04+ / Fedora 35+ / Debian 11+
66+
|x86_64 and aarch64 supported
67+
68+
|**macOS**
69+
|macOS 11+
70+
|Intel and Apple Silicon
71+
72+
|**Windows**
73+
|Windows 10+ with WSL2
74+
|Native support planned
75+
|===
76+
77+
=== Dependencies
78+
79+
[source,bash]
80+
----
81+
# Debian/Ubuntu
82+
sudo apt-get update
83+
sudo apt-get install -y curl git
84+
85+
# Fedora/RHEL
86+
sudo dnf install -y curl git
87+
88+
# macOS (via Homebrew)
89+
brew install curl git
90+
----
91+
92+
=== asdf Installation
93+
94+
[source,bash]
95+
----
96+
# Clone asdf
97+
git clone https://github.com/asdf-vm/asdf.git ~/.asdf --branch v0.14.0
98+
99+
# Add to your shell (bash)
100+
echo '. "$HOME/.asdf/asdf.sh"' >> ~/.bashrc
101+
echo '. "$HOME/.asdf/completions/asdf.bash"' >> ~/.bashrc
102+
103+
# Reload your shell
104+
exec $SHELL
105+
----
106+
107+
== Installation
108+
109+
=== Adding the Plugin
110+
111+
[source,bash]
112+
----
113+
asdf plugin add rescript https://github.com/hyperpolymath/asdf-rescript-plugin.git
114+
asdf plugin list
115+
----
116+
117+
=== Installing Rescript Versions
118+
119+
[source,bash]
120+
----
121+
asdf list all rescript
122+
asdf install rescript latest
123+
asdf install rescript 0.1.0
124+
----
125+
126+
=== Setting the Version
127+
128+
[source,bash]
129+
----
130+
asdf global rescript 0.1.0
131+
asdf local rescript 0.1.0
132+
asdf current rescript
133+
rescript --version
134+
----
135+
136+
== Usage
137+
138+
=== Project Configuration
139+
140+
[source]
141+
----
142+
rescript 0.1.0
143+
----
144+
145+
== Configuration
146+
147+
This plugin uses standard asdf behavior. No additional configuration is
148+
required.
149+
150+
== Troubleshooting
151+
152+
* Ensure `rescript` is on PATH after installation.
153+
* Verify the installed version with `rescript --version`.
154+
* Reinstall if a cached release is corrupted.
155+
156+
== Contributing
157+
158+
See link:CONTRIBUTING.adoc[CONTRIBUTING] for guidelines.
159+
160+
== License
161+
162+
Palimpsest-MPL License v1.0 (PMPL-1.0)—see link:LICENSE[LICENSE].

0 commit comments

Comments
 (0)