From 3be8efc92fa57721099df39b5b7da33c57bf8ca1 Mon Sep 17 00:00:00 2001 From: Simon Forman Date: Mon, 22 Nov 2021 19:48:59 -0800 Subject: [PATCH] Wrap README.md --- docs/README.md | 50 +++++++++++++++++++++++++++++++++++--------------- 1 file changed, 35 insertions(+), 15 deletions(-) diff --git a/docs/README.md b/docs/README.md index e7502fd..874c753 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,21 +1,28 @@ # Some Jupyter Notebooks and other material. -All of the notebooks are also available as HTML and Markdown files (generated using nbconvert) so you can view them without running Jupyter. +All of the notebooks are also available as HTML and Markdown files +(generated using nbconvert) so you can view them without running Jupyter. -In order to run the [Jupyter Notebooks](https://jupyter.org/index.html) you need Jupyter (obviously) and you should install `Joypy`. Here's an example using `virtualenv` from the project directory: +In order to run the [Jupyter Notebooks](https://jupyter.org/index.html) +you need Jupyter (obviously) and you should install `Joypy`. Here's an +example using `virtualenv` from the project directory: virtualenv --system-site-packages venv source ./venv/bin/activate pip install notebook python ./setup.py install -Once that's done you should be able to start Jupyter Notebook server with, e.g.: +Once that's done you should be able to start Jupyter Notebook server +with, e.g.: python -m notebook --ip=0.0.0.0 -This starts it using the `virtualenv` version of Python so `joy` will be available. Navigate to the `joypy/docs` directory and the notebooks should be able to import the `notebook_preamble.py` file. +This starts it using the `virtualenv` version of Python so `joy` will be +available. Navigate to the `joypy/docs` directory and the notebooks +should be able to import the `notebook_preamble.py` file. -I find I have to include `--ip=0.0.0.0` to workaround a bug where it tries to bind to an IPv6 address, YMMV. +I find I have to include `--ip=0.0.0.0` to workaround a bug where it +tries to bind to an IPv6 address, YMMV. Clean up when you're done: @@ -27,18 +34,31 @@ Clean up when you're done: ## Table of Contents - 1. Basic Use of Joy in a Notebook -- 2. Library Examples - Short examples of each word in the dictionary. Various formats. -- 3. Developing a Program - Working with the first problem from Project Euler, "Find the sum of all the multiples of 3 or 5 below 1000", several forms of the program are derived. -- 4. Replacing Functions in the Dictionary - Shows the basics of defining new "primitive" functions in Python or as definitions and adding them to the dictionary. -- Factorial Function and Paramorphisms - A basic pattern of recursive control-flow. -- Generator Programs - Using the x combinator to make generator programs which can be used to create unbounded streams of values. -- Hylo-, Ana-, Cata-morphisms - Some basic patterns of recursive control-flow structures. +- 2. Library Examples - Short examples of each word in the dictionary. + Various formats. +- 3. Developing a Program - Working with the first problem from Project + Euler, "Find the sum of all the multiples of 3 or 5 below 1000", + several forms of the program are derived. +- 4. Replacing Functions in the Dictionary - Shows the basics of defining + new "primitive" functions in Python or as definitions and adding them + to the dictionary. +- Factorial Function and Paramorphisms - A basic pattern of recursive + control-flow. +- Generator Programs - Using the x combinator to make generator programs + which can be used to create unbounded streams of values. +- Hylo-, Ana-, Cata-morphisms - Some basic patterns of recursive + control-flow structures. - Quadratic - Not-so-annoying Quadratic Formula. - Trees - Ordered Binary Trees in Joy and more recursion. -- Zipper - A preliminary examination of the idea of data-structure "zippers" for traversing datastructures. -- notebook_preamble.py - Imported into notebooks to simplify the preamble code. -- pe1.py pe1.txt - Set up and execute a Joy program for the first problem from Project Euler. The pe1.txt file is the trace. It's 2.8M uncompressed. Compressed with gzip it becomes just 0.12M. -- repl.py - Run this script to start a REPL. Useful for e.g. running Joy code in a debugger. +- Zipper - A preliminary examination of the idea of data-structure + "zippers" for traversing datastructures. +- notebook_preamble.py - Imported into notebooks to simplify the preamble + code. +- pe1.py pe1.txt - Set up and execute a Joy program for the first problem + from Project Euler. The pe1.txt file is the trace. It's 2.8M + uncompressed. Compressed with gzip it becomes just 0.12M. +- repl.py - Run this script to start a REPL. Useful for e.g. running Joy + code in a debugger. ## Notes