From 2b5714d8e2d6792e5557a9d0abbb741d5f46d279 Mon Sep 17 00:00:00 2001 From: Alisa211 <167956904+Alisa211@users.noreply.github.com> Date: Sun, 18 Jan 2026 21:51:42 +0530 Subject: [PATCH] docs: clarify running Octave from inst directory for development --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f1bda4062..dd155ba0c 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ Symbolic Package for GNU Octave =============================== An implementation of a symbolic toolbox using SymPy. +A lightweight interface that uses SymPy for symbolic math from Octave — suitable for experimenting with symbolic linear algebra, expressions and simple symbolic workflows. + https://octave.sourceforge.io/symbolic @@ -14,6 +16,12 @@ Goals Feature parity with the other symbolic toolboxes. +Goals +- Provide core symbolic functionality (diff, simplify, solve) +- Maintain clean Python↔Octave communication using SymPy representations +- Improve test coverage and cross-platform install experience + + ![Screenshot 1](/screenshot.png) ![Screenshot 2](/screenshot-install.png) @@ -90,9 +98,13 @@ How to hack on the code: 1. Clone the repo with git (preferred, but you can use the "Download ZIP" instead if you want). -2. Run Octave in the `inst/` directory. It should be safe - to do this even if you have the released version of the package - installed (but not loaded). +2. Run Octave from the `inst/` directory so that Octave uses the package + source directly instead of an installed version. For example: + + ```sh + cd symbolic/inst + octave +