diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..87df5a1 --- /dev/null +++ b/.gitignore @@ -0,0 +1,24 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e85d945 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# How to Contribute + +## Contributor License Agreement + +Contributions to this project must be accompanied by a Contributor License +Agreement. You (or your employer) retain the copyright to your contribution, +this simply gives us permission to use and redistribute your contributions as +part of the project. Head over to to see +your current agreements on file or to sign a new one. + +You generally only need to submit a CLA once, so if you've already submitted one +(even if it was for a different project), you probably don't need to do it +again. + +## Code reviews + +All submissions, including submissions by project members, require review. We +use GitHub pull requests for this purpose. Consult +[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more +information on using pull requests. + +## Community Guidelines + +This project follows [Google's Open Source Community +Guidelines](https://opensource.google/conduct/). diff --git a/README.md b/README.md new file mode 100644 index 0000000..d7ce69a --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# alphageometry + +TODO(b/303301137): Add a description for your new project, explain what is +being released here, etc... Additional, the following sections are normally +expected for all releases. Feel free to add additional sections if appropriate +for your project. + +## Installation + +Write instructions for how the user should install your code. The instructions +should ideally be valid when copy-pasted. You can combine this with the Usage +section if there's no separate installation step. + +## Usage + +Write example usage of your code. The instructions should ideally be valid when +copy-pasted, and will be used by your technical reviewer to verify that your +package functions correctly. + +## Citing this work + +Add citation details here, usually a pastable BibTeX snippet. + +## License and disclaimer + +Copyright 2023 DeepMind Technologies Limited + +All software is licensed under the Apache License, Version 2.0 (Apache 2.0); +you may not use this file except in compliance with the Apache 2.0 license. +You may obtain a copy of the Apache 2.0 license at: +https://www.apache.org/licenses/LICENSE-2.0 + +All other materials are licensed under the Creative Commons Attribution 4.0 +International License (CC-BY). You may obtain a copy of the CC-BY license at: +https://creativecommons.org/licenses/by/4.0/legalcode + +Unless required by applicable law or agreed to in writing, all software and +materials distributed here under the Apache 2.0 or CC-BY licenses are +distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, +either express or implied. See the licenses for the specific language governing +permissions and limitations under those licenses. + +This is not an official Google product.