Skip to content

Commit

Permalink
Add a bit more info to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
Nathan Smith authored Sep 17, 2016
1 parent b09689b commit 9b1a72a
Showing 1 changed file with 37 additions and 4 deletions.
41 changes: 37 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,39 @@
# Maxima.jl
# Maxima.jl

Maxima.jl is a tool for symbolic computation in Julia using the Maxima computer
algebra system.
*Symbolic Computations in Julia using Maxima*

Read the [documentation](https://nsmith5.github.io/Maxima.jl) for details!
Maxima.jl is a Julia package for performing symbolic computations using Maxima.
Maxima is computer algebra software that provides a free and open source
alternative to proprietary software such as Mathematica, Maple and others.

Checkout the [documentation](https://nsmith5.github.io/Maxima.jl) for details!

## Features

- Contains a full Maxima repl that can be entered from the Julia repl
- Pretty I/O for Maxima expressions including Latex when using IJulia and formatted '2d' plain text in the repl
- Basic translation of expressions between Maxima and Julia
- Wrapper functions for much of the Maxima standard library that operate on Maxima expressions, Julia expressions and strings
- Plotting via Maxima's gnuplot functionality

## Installation

Maxima.jl can be installed using the Julia package manager by cloning the
repository from github. Maxima.jl currently supports version of Julia >= v0.4.0.

```julia
julia> Pkg.clone("https://github.com/nsmith5/Maxima.jl.git")

```

Maxima.jl requires a working Maxima installation. Downloads and installation
instructions can be found [here](http://maxima.sourceforge.net/). If you're
running a Linux operating system take a look in your local repositories.

Once Maxima is installed, check that it is accessible from the Julia shell.

```julia
julia> run(`maxima`)
```

A Maxima shell should open and you can quit it by entering `quit(); <return>` at the prompt.

0 comments on commit 9b1a72a

Please sign in to comment.