From fa47eca11fa14753b02e59d6ccafc59ea4c0ae55 Mon Sep 17 00:00:00 2001 From: ikappaki Date: Mon, 2 Dec 2024 20:43:50 +0000 Subject: [PATCH] up --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 33f6b40..6c965bd 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ For additional configuration options, such as specifying a port with `:port` or ## Getting started with Basilisp Notebooks -### Local Basilisp Files +### 1. Local Basilisp Files You can seamlessly write and use Basilisp `.lpy` files in the same directory as your Notebook. These files can be required in the Notebook just like standard Basilisp namespaces. @@ -91,7 +91,7 @@ For example, if you create a file named `dev.lpy` with the following content You can load and use it in your Notebook as follows ```Clojure -[n]: (require 'dev) +[n]: (require 'dev) [n+1]: (dev/hello) :hi ``` @@ -136,7 +136,8 @@ Both [Emacs/CIDER](https://docs.cider.mx/cider/platforms/basilisp.html) and [VSC The Editor should now connect seamlessly to the nREPL server. -### Batteries Included Project: `basilex-notebook` +*** +### 2. Batteries Included Project: `basilex-notebook` The [Basilisp Example Notebook](https://github.com/ikappaki/basilex-notebook) repository, is an excellent resource for exploring Basilisp notebooks. It includes Jupyter, the Basilisp kernel, a skeleton Basilisp library, and a development notebook to help you get started. @@ -154,9 +155,10 @@ $ poetry shell () $ jupyter notebook ``` +*** 3. Open the `dev.ipynb` notebook from the Jupyter interface. Refer to the [basilex-notebook documentation](https://github.com/ikappaki/basilex-notebook) for more details. -### Basilisp Example Library Project: `basilex-basilib` +### 3. Basilisp Example Library Project: `basilex-basilib` The [Basilisp Example Library](https://github.com/ikappaki/basilex-basilib) repository provides a starting point for setting up an external Basilisp library that can be integrated with your notebooks.