Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/run-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ jobs:
tox run-parallel -p 2
report-coverage:
runs-on: ubuntu-22.04
runs-on: ubuntu-latest
needs:
- run-tests
- run-pypy-tests
Expand Down
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [v0.3.0]
### Added
* Added support for Python 3.13 (#1056)
* Added support for `.cljc` files (#1097)
Expand Down Expand Up @@ -619,6 +621,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added
- Basilisp language and compiler base.

[v0.3.0]: https://github.com/basilisp-lang/basilisp/compare/v0.2.4..v0.3.0
[v0.2.4]: https://github.com/basilisp-lang/basilisp/compare/v0.2.3..v0.2.4
[v0.2.3]: https://github.com/basilisp-lang/basilisp/compare/v0.2.2..v0.2.3
[v0.2.2]: https://github.com/basilisp-lang/basilisp/compare/v0.2.1..v0.2.2
Expand Down
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,20 @@ exploration at the REPL. Additionally, Basilisp features many of the same functi
and idioms as [Clojure](https://clojure.org/), so you may find guides and
documentation there helpful for getting started.

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

## Why does this project exist?

Basilisp is a project I (@chrisrink10) created to learn about Python, Clojure,
hosted languages, and compilers.

That said, it is generally stable at this point with reasonably high test
coverage, linting, and type checking. Work is ongoing to complete the rest of
coverage, linting, and type checking. Work is ongoing to complete the rest of the
standard the library implementations. I suspect it could be used to build small
applications and tools at this point, though I would not recommend it unless you
like being a very early adopter.
like being an early adopter.

_Use in a production setting at your own risk._

Expand Down
21 changes: 17 additions & 4 deletions docs/gettingstarted.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,29 @@
Getting Started
===============

.. _installation_and_first_steps:
.. _installation:

Installation & First Steps
--------------------------
Installation
------------

Basilisp is developed on `GitHub <https://github.com/chrisrink10/basilisp>`_ and hosted on `PyPI <https://pypi.python.org/pypi/basilisp>`_.
You can fetch Basilisp using a simple::
You can fetch the latest version of Basilisp from PyPI using ``pip``::

pip install basilisp

.. note::

This will pull the latest version of Basilisp from PyPI, but ``pip`` also offers a variety of other ways to select specific versions of libraries.
Users looking to try out cutting edge versions of Basilisp may instead prefer to use ``pip``'s builtin `support for installing libraries directly from VCS <https://pip.pypa.io/en/stable/topics/vcs-support/>`_.
You can install Basilisp directly from the Git ``main`` ref (for example) using a command like this::

pip install "basilisp @ git+https://github.com/basilisp-lang/basilisp.git@main"

.. _first_steps:

First Steps
-----------

Once Basilisp is installed, you can enter into the REPL using::

basilisp repl
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "basilisp"
version = "0.2.4"
version = "0.3.0"
description = "A Clojure-like lisp written for Python"
authors = ["Christopher Rink <[email protected]>"]
license = "Eclipse Public License 1.0 (EPL-1.0)"
Expand Down