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

Jump to bottom

Rewrite README #21

Open

egpbos opened this issue Nov 15, 2017 · 1 comment

Labels

Member

egpbos commented Nov 15, 2017

Take inspiration from the other xtensor pages, e.g. xensor-io has a nice compact one, that would be good as a header. The rest can be something like:

Intro
Example
Installation
Dependencies
Usage (i.e. more examples, or links to notebooks/binder)
Building and running the tests
License

egpbos added a commit that referenced this issue


          Added example to readme (#21)

98d37e5

egpbos added a commit that referenced this issue


          Readme (#21): install, deps, tests

bdb9bdf

egpbos added a commit that referenced this issue


          Added example to readme (#21)

3e46b2e

egpbos added a commit that referenced this issue


          Readme (#21): install, deps, tests

daaab18

Member Author

egpbos commented Nov 29, 2017 •

edited

Loading

Still todo:

A bit more introduction (see e.g. https://github.com/QuantStack/xtensor-io#introduction)
More usage examples and links to notebooks / binder (Build demo #18)

egpbos added the documentation label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment