diff --git a/README.md b/README.md index 18c6670f..5be402ca 100644 --- a/README.md +++ b/README.md @@ -49,16 +49,15 @@ If you want to hack on the Tablicious code itself, set it up like this: Once you have Tablicious installed, the user manual will show up in the Octave GUI’s documentation browser. You can also run `help ` or `doc ` for any of the classes or functions in Tablicious. -The documentation for the latest development version can be viewed online at . +The documentation for the latest development version can be viewed online at . -See the `doc-project/` directory for notes on this project, especially for [Developer Notes](doc-project/Developer-Notes.md) and [Design and Justification](doc-project/Design-and-Justification.md), which discusses how and why this library is written. -Also see [CONTRIBUTING](CONTRIBUTING.md) if you would like to contribute to this project. +See the `docs/` directory for notes on this project, especially for [Developer Notes](docs/Developer-Notes.md) and [Design and Justification](docs/Design-and-Justification.md), which discusses how and why this library is written. Also see [CONTRIBUTING](CONTRIBUTING.md) if you would like to contribute to this project. ## Contributing See [CONTRIBUTING.md](CONTRIBUTING.md) for more details. -### No Matlab usage! +### No Matlab Usage To avoid issues with the Matlab license's Non-Compete clause, this project needs to be developed entirely using Octave, and not using Matlab at all, including for testing or benchmarking purposes. Please do not submit any Matlab test or benchmark results, or any code produced using Matlab. And if you know anything about how the Matlab internals work, please do not tell me! diff --git a/docs/Design-and-Justification.md b/docs/Design-and-Justification.md index e9dce8c5..a6e18484 100644 --- a/docs/Design-and-Justification.md +++ b/docs/Design-and-Justification.md @@ -4,8 +4,6 @@ This document describes the design choices I made in Tablicious, and some justifications for them and why I think they should be allowed into core Octave, or at least an Octave Forge package. -# Design - ## Objects ### Copy constructors @@ -147,9 +145,9 @@ I’m thinking about breaking the `load` step out into separate `load_raw` and `munge` steps, to make it easier for users to view the example dataset code and see how the data-packaging classes like `table` are used. -# Justification +## Justification -## Why does `table` display differently than in Matlab? +### Why does `table` display differently than in Matlab? In Matlab, doing `disp()` on a `table` will result in its printing the entire table contents in tabular form, as it does with primitives and @@ -164,7 +162,7 @@ each way, and found the summary style to be much more usable. I think this is fine because `disp()` is mostly used for interactive use, and is not frequently used to produce actual program output, so this shouldn't be a real compatibility issue. -## Justify all these new top-level functions +### Justify all these new top-level functions Tablicious defines several new top-level (global, not in namespaces or `private/` directories) functions. Many of them are ports of Matlab diff --git a/docs/index.md b/docs/index.md index 849f53c3..19a7426c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,5 @@ +# Tablicious Online Documentation + This is the documentation site for Tablicious. Tablicious is a package for GNU Octave that provides relational data structures for Octave. It includes implementations of `table` arrays, `datetime`, `string`, `categorical`, and some other related stuff. You can think of it as "pandas for Octave".