Skip to content

Docs: clarify how to run Octave from inst directory when hacking #1331

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Alisa211 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Docs: clarify how to run Octave from inst directory when hacking #1331

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 15 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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)
Expand Down Expand Up @@ -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

Comment on lines +104 to +107

@cbm755 cbm755 Feb 23, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```sh
cd symbolic/inst
octave
```sh
cd symbolic/inst
octave 

(Maybe Github is acting up but I can't see the closing three tics)




Expand Down