Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Small improvements to the README... #69

Open
wants to merge 5 commits into
base: hello-schemer
Choose a base branch
from
Open

Small improvements to the README... #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d8df542
README: add direct link to github project, and adjust wording...
May 18, 2022
29e0d34
README: add getting started section with docs...
May 18, 2022
7659f08
makefile: check-with-docker: remove it...
May 18, 2022
05f05dc
README: Getting started: add missing command.
Jun 5, 2022
ae820a8
README: bring back 'fast-moving'...
Jun 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# [scheme-live](https://github.com/scheme-live/live)

**Fast-moving Scheme library collection with yearly stable releases**

## Prelude

Let's agree that *serif* fonts do not always carry boring stuff. And have a taste of it:

> Programming languages should be designed not by piling feature on
Expand Down Expand Up @@ -29,3 +33,11 @@ upon which one can build abstractions to solve (real world) problems.

- Libraries inside `unstable` are always subject to change;

## Getting started

```shell
% sudo make prepare-debian
% ./venv
% scheme-live install
% IMPLEMENTATION=chez make check
```
1 change: 1 addition & 0 deletions debian-system-dependencies.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,4 @@ texinfo
uuid-dev
wget
zlib1g-dev
podman
5 changes: 0 additions & 5 deletions makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,6 @@ prepare-debian: ## Prepare a Debian host (call with sudo)
apt update
apt install --yes --no-install-recommends $(shell cat debian-system-dependencies.txt | tr '\n' ' ')

check-with-docker: ## Run checks with docker
env | grep "^IMPLEMENTATION=" # requires an implementation
env | grep "^IMAGE=" # requires a docker image
docker run --volume $(PWD):/live --interactive --rm $(IMAGE) /bin/sh -c "cd /live && apt update && apt install --yes $(shell cat debian-system-dependencies.txt | tr '\n' ' ') && ./venv make IMPLEMENTATION=$(IMPLEMENTATION) check"

check: ## Run tests
env | grep "^IMPLEMENTATION=" # requires an env variable called IMPLEMENTATION
./local/bin/scheme-live $(IMPLEMENTATION) check $(PWD)
Expand Down