Skip to content

Commit ffd374b

Browse files
committed
Document platform support and installation instructions
- Add comprehensive platform support section (Linux, FreeBSD, macOS, Windows) - Document Unix installation with make/gmake - Add Windows-specific installation notes (pure Lisp CFFI, no C compilation) - Include installation examples with PREFIX customization - Clarify Windows support after PR lem-project#26 refactoring
1 parent 44aef4e commit ffd374b

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,53 @@
11
# async-process
22

3+
A Common Lisp library for creating and managing asynchronous processes with PTY support.
4+
5+
## Platform Support
6+
7+
- **Linux**: Full support via C library using PTY
8+
- **FreeBSD**: Full support via C library using PTY
9+
- **macOS**: Full support via C library using PTY
10+
- **Windows**: Full support via pure Lisp CFFI implementation (no C compilation required)
11+
12+
## Installation
13+
14+
### Unix-like Systems (Linux, FreeBSD, macOS)
15+
16+
```bash
17+
git clone https://github.com/soppelmann/async-process.git
18+
cd async-process
19+
make
20+
sudo make install
21+
```
22+
23+
The library installs to `/usr/local` by default. To install elsewhere:
24+
25+
```bash
26+
make install PREFIX=/usr
27+
make install PREFIX=$HOME/.local
28+
```
29+
30+
See [INSTALL](INSTALL) for detailed installation instructions.
31+
32+
### Windows
33+
34+
On Windows, no C compilation is required. The library uses a pure Lisp implementation via CFFI:
35+
36+
```bash
37+
git clone https://github.com/soppelmann/async-process.git
38+
cd async-process
39+
```
40+
41+
Then simply load the library in your Lisp environment:
42+
43+
```lisp
44+
(ql:quickload :async-process)
45+
```
46+
47+
The ASDF system will automatically load the Windows-specific implementation (`src/async-process_windows.lisp`) when on Windows platforms.
48+
49+
## Usage
50+
351
```
452
CL-USER> (ql:quickload :async-process)
553
To load "async-process":

0 commit comments

Comments
 (0)