Browse Source

Initial commit - LICENSE, README, gitignore

pull/1/head
Ralf Gommers 2 years ago
commit
88ded5b6eb
  1. 91
      .gitignore
  2. 30
      LICENSE.txt
  3. 22
      README.md

91
.gitignore vendored

@ -0,0 +1,91 @@
# Editor temporary/working/backup files #
#########################################
.#*
[#]*#
*~
*$
*.bak
*.diff
.idea/
*.iml
*.ipr
*.iws
*.org
.project
pmip
*.rej
.settings/
.*.sw[nop]
.sw[nop]
*.tmp
*.vim
.vscode
tags
cscope.out
# Compiled source #
###################
*.a
*.com
*.class
*.dll
*.exe
*.o
*.o.d
*.py[ocd]
*.so
# Packages #
############
# it's better to unpack these files and commit the raw source
# git has its own built in compression methods
*.7z
*.bz2
*.bzip2
*.dmg
*.gz
*.iso
*.jar
*.rar
*.tar
*.tbz2
*.tgz
*.zip
# Python files #
################
# setup.py working directory
build
# sphinx build directory
_build
# Egg metadata
*.egg-info
MANIFEST
.cache
# Logs and databases #
######################
*.log
# Patches #
###########
*.patch
*.diff
# OS generated files #
######################
.DS_Store*
.VolumeIcon.icns
.fseventsd
Icon?
.gdb_history
ehthumbs.db
Thumbs.db
.directory
# pytest generated files #
##########################
/.pytest_cache
# Things specific to this project #
###################################

30
LICENSE.txt

@ -0,0 +1,30 @@
Copyright (c) 2005-2020, NumPy Developers.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided
with the distribution.
* Neither the name of the NumPy Developers nor the names of any
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

22
README.md

@ -0,0 +1,22 @@
# NumPy tutorials
This set of tutorials and educational materials is being developed,
IT IS NOT YET INTEGRATED IN THE HTML DOCS AT https://www.numpy.org/devdocs/
The goal of this repository is to provide high-quality resources by the
NumPy project, both for self-learning and for teaching classes with.
## Contributing
We very much welcome contributions! If you have an idea or proposal for a new
tutorial, please open an issue with an outline.
The following may be useful:
- [NumPy documentation team meetings](https://hackmd.io/oB_boakvRqKR-_2jRV-Qjg?both)
- [NEP 44 - Restructuring the NumPy documentation](https://numpy.org/neps/nep-0044-restructuring-numpy-docs.html)
- [Blog post - Documentation as a way to build Community](https://labs.quansight.org/blog/2020/03/documentation-as-a-way-to-build-community/)
- Note that regular documentation issues for NumPy can be found in the
[main NumPy repository](https://github.com/numpy/numpy/issues) (see the
`Documentation` labels (2x) there)
Loading…
Cancel
Save