Skip to content

Commit ccc2239

Browse files
authored
Update README and documentation index (#1324)
1 parent fdecebf commit ccc2239

3 files changed

Lines changed: 52 additions & 21 deletions

File tree

README.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
# 🐍 basilisp 🐍
22

3-
A Clojure-compatible(-ish) Lisp dialect targeting Python 3.10+.
3+
A Clojure-compatible(-ish) Lisp dialect hosted on Python 3 with seamless Python
4+
interop.
45

5-
[![PyPI](https://img.shields.io/pypi/v/basilisp.svg?style=flat-square)](https://pypi.org/project/basilisp/) [![python](https://img.shields.io/pypi/pyversions/basilisp.svg?style=flat-square)](https://pypi.org/project/basilisp/) [![pyimpl](https://img.shields.io/pypi/implementation/basilisp.svg?style=flat-square)](https://pypi.org/project/basilisp/) [![readthedocs](https://img.shields.io/readthedocs/basilisp.svg?style=flat-square)](https://basilisp.readthedocs.io/) [![Run tests](https://github.com/basilisp-lang/basilisp/actions/workflows/run-tests.yml/badge.svg?branch=main)](https://github.com/basilisp-lang/basilisp/actions/workflows/run-tests.yml) [![Coveralls github](https://img.shields.io/coveralls/github/basilisp-lang/basilisp.svg?style=flat-square)](https://coveralls.io/github/basilisp-lang/basilisp) [![license](https://img.shields.io/github/license/basilisp-lang/basilisp.svg?style=flat-square)](https://github.com/basilisp-lang/basilisp/blob/master/LICENSE) [![Slack](https://img.shields.io/badge/Slack-Clojurians-green?style=flat-square)](https://clojurians.slack.com/archives/C071RFV2Z1D)
6+
[![PyPI](https://img.shields.io/pypi/v/basilisp.svg?style=flat-square)](https://pypi.org/project/basilisp/) [![python](https://img.shields.io/pypi/pyversions/basilisp.svg?style=flat-square)](https://pypi.org/project/basilisp/) [![pyimpl](https://img.shields.io/pypi/implementation/basilisp.svg?style=flat-square)](https://pypi.org/project/basilisp/) [![readthedocs](https://img.shields.io/readthedocs/basilisp.svg?style=flat-square)](https://basilisp.readthedocs.io/) [![Run tests](https://github.com/basilisp-lang/basilisp/actions/workflows/run-tests.yml/badge.svg?branch=main)](https://github.com/basilisp-lang/basilisp/actions/workflows/run-tests.yml) [![Run clojure-test-suite](https://github.com/basilisp-lang/basilisp/actions/workflows/run-clojure-test-suite.yml/badge.svg?branch=main)](https://github.com/basilisp-lang/basilisp/actions/workflows/run-clojure-test-suite.yml) [![Coveralls github](https://img.shields.io/coveralls/github/basilisp-lang/basilisp.svg?style=flat-square)](https://coveralls.io/github/basilisp-lang/basilisp) [![license](https://img.shields.io/github/license/basilisp-lang/basilisp.svg?style=flat-square)](https://github.com/basilisp-lang/basilisp/blob/master/LICENSE) [![Slack](https://img.shields.io/badge/Slack-Clojurians-green?style=flat-square)](https://clojurians.slack.com/archives/C071RFV2Z1D)
67

78
## Getting Started
89

910
Basilisp is developed on [GitHub](https://github.com/basilisp-lang/basilisp) and
1011
hosted on [PyPI](https://pypi.python.org/pypi/basilisp). You can fetch Basilisp
11-
using `pip`:
12+
using `pip` (or any other Python dependency manager which can pull from PyPI):
1213

1314
```bash
1415
pip install basilisp
@@ -20,27 +21,24 @@ Once Basilisp is installed, you can enter into the REPL using:
2021
basilisp repl
2122
```
2223

23-
Basilisp [documentation](https://basilisp.readthedocs.io) can help guide your
24-
exploration at the REPL. Additionally, Basilisp features many of the same functions
25-
and idioms as [Clojure](https://clojure.org/), so you may find guides and
26-
documentation there helpful for getting started.
24+
## Documentation
25+
26+
Basilisp [documentation](https://docs.basilisp.org) can help guide your
27+
exploration at the REPL and beyond. Additionally, Basilisp features many of the
28+
same functions and idioms as [Clojure](https://clojure.org/), so you may find
29+
guides and documentation there helpful for getting started.
2730

2831
For those who prefer a video introduction, feel free to check out this
2932
[talk](https://youtu.be/ruGRHYpq448?si=0jr2a6uWlq6Vi2_k) hosted by the
3033
[London Clojurians](https://www.meetup.com/london-clojurians/) group about Basilisp.
3134

32-
## Why does this project exist?
33-
34-
Basilisp is a project I (@chrisrink10) created to learn about Python, Clojure,
35-
hosted languages, and compilers.
35+
## Contributing
3636

37-
That said, it is generally stable at this point with reasonably high test
38-
coverage, linting, and type checking. Work is ongoing to complete the rest of the
39-
standard library implementations. I suspect it could be used to build small
40-
applications and tools at this point, though I would not recommend it unless you
41-
like being an early adopter.
37+
Contributions are welcome, but please review the [contributing guidelines](https://docs.basilisp.org/en/latest/contributing.html)
38+
before submitting an issue or pull request.
4239

43-
_Use in a production setting at your own risk._
40+
If you have a question, please use [Github Discussions](https://github.com/basilisp-lang/basilisp/discussions)
41+
or post in the [`#basilisp` channel](https://clojurians.slack.com/archives/C0A2CQQQVPB) in the Clojurians Slack.
4442

4543
## License
4644

docs/index.rst

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,35 @@
66
Welcome to Basilisp's documentation!
77
====================================
88

9-
Basilisp is a :ref:`Clojure-compatible(-ish) <differences_from_clojure>` Lisp dialect targeting Python 3.10+.
9+
.. image:: https://img.shields.io/badge/Github-basilisp-green?style=flat-square
10+
:target: https://github.com/basilisp-lang/basilisp
11+
:alt: Link to Basilisp Github repository
12+
.. image:: https://img.shields.io/pypi/v/basilisp.svg?style=flat-square
13+
:target: https://pypi.org/project/basilisp/
14+
:alt: Link to Basilisp PyPI page for current release; shows the current release version
15+
.. image:: https://img.shields.io/pypi/pyversions/basilisp.svg?style=flat-square
16+
:target: https://pypi.org/project/basilisp/
17+
:alt: Link to Basilisp PyPI page for current release; shows currently supported Python versions
18+
.. image:: https://img.shields.io/readthedocs/basilisp.svg?style=flat-square
19+
:target: https://docs.basilisp.org
20+
:alt: Link to Basilisp documentation
21+
.. image:: https://github.com/basilisp-lang/basilisp/actions/workflows/run-tests.yml/badge.svg?branch=main&style=flat-square
22+
:target: https://github.com/basilisp-lang/basilisp/actions/workflows/run-tests.yml
23+
:alt: Link to Basilisp test CI workflow on Github Actions
24+
.. image:: https://github.com/basilisp-lang/basilisp/actions/workflows/run-clojure-test-suite.yml/badge.svg?branch=main&style=flat-square
25+
:target: https://github.com/basilisp-lang/basilisp/actions/workflows/run-clojure-test-suite.yml
26+
:alt: Link to Basilisp clojure-test-suite CI workflow on Github Actions
27+
.. image:: https://img.shields.io/coveralls/github/basilisp-lang/basilisp.svg?style=flat-square
28+
:target: https://coveralls.io/github/basilisp-lang/basilisp
29+
:alt: Link to Basilisp Coverage report on Coveralls
30+
.. image:: https://img.shields.io/github/license/basilisp-lang/basilisp.svg?style=flat-square
31+
:target: https://github.com/basilisp-lang/basilisp/blob/master/LICENSE
32+
:alt: Link to Basilisp license file
33+
.. image:: https://img.shields.io/badge/Slack-Clojurians-green?style=flat-square
34+
:target: https://clojurians.slack.com/archives/C071RFV2Z1D
35+
:alt: Link to Basilisp channel on Clojurians Slack
36+
37+
Basilisp is a :ref:`Clojure-compatible(-ish) <differences_from_clojure>` Lisp dialect hosted on Python 3 with seamless Python interop.
1038

1139
Basilisp compiles down to raw Python 3 code and executes on the Python 3 virtual machine, allowing natural interoperability between existing Python libraries and new Lisp code.
1240

pyproject.toml

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[project]
22
name = "basilisp"
33
version = "0.5.0"
4-
description = "A Clojure-like lisp written for Python"
4+
description = "A Clojure-compatible(-ish) Lisp dialect hosted on Python 3 with seamless Python interop."
55
authors = [
66
{ name = "Christopher Rink", email = "chris@crink.dev" },
77
]
@@ -11,8 +11,6 @@ requires-python = ">=3.10"
1111
packages = [
1212
{ include = "basilisp", from = "src" },
1313
]
14-
repository = "https://github.com/basilisp-lang/basilisp"
15-
documentation = "https://basilisp.readthedocs.io/"
1614
classifiers = [
1715
# Trove classifiers
1816
# Full list: https://pypi.python.org/pypi?%3Aaction=list_classifiers
@@ -38,6 +36,13 @@ dependencies = [
3836
"typing-extensions (>=4.7.0,<5.0.0)",
3937
]
4038

39+
[project.urls]
40+
Homepage = "https://github.com/basilisp-lang/basilisp"
41+
Documentation = "https://docs.basilisp.org"
42+
Repository = "https://github.com/basilisp-lang/basilisp"
43+
"Bug Tracker" = "https://github.com/basilisp-lang/basilisp/issues"
44+
Changelog = "https://github.com/basilisp-lang/basilisp/blob/main/CHANGELOG.md"
45+
4146
[dependency-groups]
4247
dev = [
4348
"black >=24.0.0",

0 commit comments

Comments
 (0)