From 9b1a72ab5e47eab8a817f0a178fca7440b4e8300 Mon Sep 17 00:00:00 2001 From: Nathan Smith Date: Sat, 17 Sep 2016 02:02:16 -0400 Subject: [PATCH] Add a bit more info to the README --- README.md | 41 +++++++++++++++++++++++++++++++++++++---- 1 file changed, 37 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d604819..ceba22d 100644 --- a/README.md +++ b/README.md @@ -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(); ` at the prompt.