Skip to content

Commit

Permalink
General clean up and link fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
karlnapf committed Nov 24, 2016
1 parent a544913 commit 20b7983
Showing 1 changed file with 10 additions and 14 deletions.
24 changes: 10 additions & 14 deletions README.md
Expand Up @@ -21,14 +21,10 @@ Buildbot: http://buildbot.shogun-toolbox.org/waterfall.
* See [doc/readme/ABOUT.md](https://github.com/shogun-toolbox/docs/blob/master/ABOUT.md) for a project description.
* See [doc/readme/INSTALL.md](https://github.com/shogun-toolbox/docs/blob/master/INSTALL.md) for installation instructions.
* See [doc/readme/INTERFACES.md](https://github.com/shogun-toolbox/docs/blob/master/INTERFACES.md) for calling Shogun from its interfaces.
* See [the cookbook](http://shogun.ml/cookbook/latest/) for API examples for all interfaces.
* See [the cookbook](http://shogun.ml/examples) for API examples for all interfaces.
* See [the wiki](https://github.com/shogun-toolbox/shogun/wiki/) for developer information.
* [doc/wiki/README.developer](https://github.com/shogun-toolbox/shogun/wiki/README_developer)
* [doc/wiki/README.data](https://github.com/shogun-toolbox/shogun/wiki/README_data)
* [doc/wiki/README.cmake](https://github.com/shogun-toolbox/shogun/wiki/README_cmake)

Quick links for this file:
* [Introduction](#introduction)
* [Interfaces](#interfaces)
* [Platforms](#platforms)
* [License](#license)
Expand All @@ -37,7 +33,7 @@ Quick links for this file:
## Interfaces
-------------

Shogun is implemented in C++ and interfaces to Python, octave, java, ruby, C#, R, Lua, Perl. JavaScript and Matlab are planned to be (re-)introduced soon.
Shogun is implemented in C++ and offers automatically generated, unified interfaces to Python, Octave, Java, Ruby, C#, R, Lua. We are currently working on adding more languages including JavaScript, D, Scala, and Matlab.

| Interface | Status |
|:----------------:|-----------------------------------------------------------|
Expand All @@ -52,13 +48,13 @@ Shogun is implemented in C++ and interfaces to Python, octave, java, ruby, C#, R
|perl | *pre-alpha* (work in progress quality) |
|js | *pre-alpha* (work in progress quality) |

See our website for examples in all languages.
See [our website](http://shogun.ml/examples) for examples in all languages.

## Platforms
------------

Shogun is supported under GNU/Linux, MacOSX, FreeBSD, and Windows.
See our buildfarm
See our [buildfarm](http://buildbot.shogun-toolbox.org/waterfall).

## Directory Contents
---------------------
Expand All @@ -67,13 +63,13 @@ The following directories are found in the source distribution.
Note that some folders are submodules that can be checked out with
`git submodule update --init`.

- *src* - source code.
- *src* - source code, separated into C++ source and interfaces
- *doc* - readmes (doc/reamde, submodule), ipython notebooks, cookbook (api examples), licenses
- *examples* - example files for all interfaces.
- *data* - data sets (submodule required for some examples / applications)
- *tests* - unit and integration tests.
- *applications* - applications of SHOGUN.
- *benchmarks* - speed benchmarks.
- *examples* - example files for all interfaces
- *data* - data sets (submodule, required for examples)
- *tests* - unit tests and continuous integration of interface examples
- *applications* - applications of SHOGUN (oudated)
- *benchmarks* - speed benchmarks
- *cmake* - cmake build scripts

## License
Expand Down

0 comments on commit 20b7983

Please sign in to comment.