Skip to content

Commit

Permalink
more
Browse files Browse the repository at this point in the history
  • Loading branch information
ikappaki committed Dec 1, 2024
1 parent cc344cb commit acb6cee
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,10 @@ The Basilisp Kernel includes an nREPL server, allowing remote interaction with n

### Starting the nREPL Server

Start the nREPL within your notebook by running:
Start the nREPL in your notebook by running:
```clojure
[n]: (require '[basilisp-kernel.nrepl-server :refer [server-start server-shut]])
[n+1]: (def server (server-start {}))
(require '[basilisp-kernel.nrepl-server :refer [server-start server-shut]])
(def server (server-start {}))
=> nREPL server started on port 58966 on host 127.0.0.1 - nrepl://127.0.0.1:58966
=> #'user/server
```
Expand All @@ -68,15 +68,17 @@ For additional configuration options, such as specifying a port with `:port` or
### Stopping the nREPL Server

```clojure
[n]: (server-shut server)
(server-shut server)
=> :shut
```

## Getting started with development
## Getting started with Basilisp Notebooks

### Batteries Included Project

The Basilisp Example Notebook repository, [basilex-notebook](https://github.com/ikappaki/basilex-notebook), is an excellent resource for exploring Basilisp notebooks. This project includes Jupyter, the Basilisp kernel, a skeleton Basilisp library, and a development notebook to help you get started.

### Setup
#### Setup

First, ensure you have [Poetry](https://python-poetry.org/docs/) installed on your system for dependency management.

Expand All @@ -92,13 +94,13 @@ $ poetry shell

From the Jupyter Notebook interface, open the `dev.ipynb` notebook to start development. For additional details, refer to the [basilex-notebook documentation](https://github.com/ikappaki/basilex-notebook).

### Extending with an external Basilisp Library
#### Basilisp Library Project

Alternatively, you can develop Basilisp Clojure code in an external library and integrate it into your Notebooks. Use the [basilex-basilib](https://github.com/ikappaki/basilex-basilib) Basilisp Example Library repository as an example.
You can develop Basilisp Clojure code in an external library and integrate it into your Notebooks. Use the [basilex-basilib](https://github.com/ikappaki/basilex-basilib) Basilisp Example Library repository as an example.

The following instructions assume you are running in a virtual environment where the project is installed as an editable package. This is indicated by the environment name prefix in your command prompt, such as `<venv>` in the examples below.
The following instructions assume you are running in a virtual environment where the Basilisp Notebooks will be opened from (e.g. `basiliex-notebook` above). This is indicated by the environment name prefix in your command prompt, such as `<venv>` in the examples below.

#### Installation
##### Installation

Clone the repository and install the `basilib` library as an editable package in your virtual environment:

Expand All @@ -109,9 +111,9 @@ Clone the repository and install the `basilib` library as an editable package in
(<env>) $ pip install -e .
```

#### Usage
##### Usage

Once installed, you can load and interact with the library from your notebook:
Once installed, you can load and interact with the library in your notebook:

```clojure
[n]: (require '[basilib.core :as bc])
Expand Down

0 comments on commit acb6cee

Please sign in to comment.