Skip to content

Commit 81f5b68

Browse files
authored
Updating with new content and note about workflow changes.
This is a follow-up to numpy#36
1 parent 97df601 commit 81f5b68

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# NumPy tutorials
22

3-
[![Binder](http://mybinder.org/badge_logo.svg)](http://mybinder.org/v2/gh/numpy/numpy-tutorials/master?urlpath=lab/tree/content)
4-
53
This set of tutorials and educational materials is being developed,
64
IT IS NOT INTEGRATED IN THE HTML DOCS AT https://www.numpy.org/devdocs/
75

@@ -10,15 +8,17 @@ NumPy project, both for self-learning and for teaching classes with. If you're
108
interested in adding your own content, check the [Contributing](#contributing)
119
section.
1210

13-
To open a live version of the content, click the **launch Binder** button above.
1411
To download a local copy of the `.ipynb` files, you can either
1512
[clone this repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository)
1613
or navigate to any of the documents listed below and download it individually.
1714

1815
## Content
1916

20-
1. [Tutorial: Linear algebra on n-dimensional arrays](content/tutorial-svd.ipynb)
21-
2. [Tutorial: CS231n Python Tutorial](content/cs231_tutorial.ipynb)
17+
0. [Learn to write a NumPy tutorial](content/tutorial-style-guide.md): our style guide for writing tutorials.
18+
1. [Tutorial: Linear algebra on n-dimensional arrays](content/tutorial-svd.md)
19+
2. [Tutorial: CS231n Python Tutorial](content/cs231_tutorial.md)
20+
3. [Tutorial: Determining Moore's Law with real data in NumPy](content/mooreslaw-tutorial.ipynb)
21+
4. [Tutorial: Saving and sharing your NumPy arrays](content/save-load-arrays.ipynb)
2222

2323
## Contributing
2424

@@ -44,19 +44,23 @@ used in the main NumPy documentation has two reasons:
4444
information.
4545
* rST may present a barrier for some people who might otherwise be very
4646
interested in contributing tutorial material.
47+
48+
#### Note
49+
50+
You may notice that some of our content is in markdown format (`.md` files). This is part of an ongoing restructuring of the repository workflow. However, you can still submit your content as a Jupyter Notebook file.
4751

4852
### Adding your own tutorials
4953

5054
If you have your own tutorial in the form of a Jupyter notebook (a `.ipynb`
51-
file) and you'd like to try add it out to the repository:
55+
file) and you'd like to add it to the repository:
5256

5357
#### Create an issue
5458

5559
Go to [https://github.com/numpy/numpy-tutorials/issues](https://github.com/numpy/numpy-tutorials/issues) and create a new issue with your proposal. Give as much detail as you can about what kind of content you would like to write (tutorial, how-to) and what you plan to cover. We will try to respond as quickly as possible with comments, if applicable.
5660

5761
#### Check out our suggested template
5862

59-
You can use our [Tutorial Style Guide](content/tutorial-style-guide.ipynb) to make your content consistent with our existing tutorials.
63+
You can use our [Tutorial Style Guide](content/tutorial-style-guide.md) to make your content consistent with our existing tutorials.
6064

6165
#### Upload your content
6266

0 commit comments

Comments
 (0)