Merge pull request #1 from orcestra-campaign/readme

add readme and contributing info to the repo

CONDUCT.md

@@ -0,0 +1,43 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant, version 1.4](http://contributor-covenant.org/version/1/4).

CONTRIBUTING.md

@@ -0,0 +1,56 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given. You can contribute in the ways listed below.
+
+## Report Bugs
+
+Report bugs using GitHub issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+## Fix Bugs and Implement Features
+
+Look through the GitHub issues for bugs and features. Anything tagged with "bug", "help
+wanted" or "enhancement" is open to whoever wants to implement it.
+
+## Write Documentation
+
+The ORCESTRA book could always use more documentation, whether through describing a
+a sub-campaign or an instrument measurement or by adding a data processing example.
+Please feel free to add information yourself or open an issue if you lack the time 
+or knowledge to add it right away.
+
+
+## Get Started
+
+Ready to contribute? Here's how to set up the `ORCESTRA book` for local development.
+
+1. Fork the repo on GitHub.
+2. Clone your fork locally.
+3. Install your local copy into a virtualenv, e.g., using `conda`: `conda env create -f environment.yml`.
+4. Create a branch for local development and make changes locally.
+5. Build the book locally to see if the fully-rendered HTML version looks as intended (see below how to).
+6. Commit your changes and push your branch to GitHub.
+7. Submit a pull request through the GitHub website.
+
+## Building the book
+
+To check your changes locally you can build the book from within the repo's root folder:
+
+```
+jupyter-book build orcestra-book/
+```
+
+A fully-rendered HTML version of the book will be built in `orcestra-book/_build/html/`.
+You can have a look at it by opening the `_build/html/index.html` file in your browser.
+In case the book builds without errors, but your changes don't seem to get rendered it might be due to the cache.
+You can force the book to be built from scratch by removing the existing `orcestra-book/_build/` directory before building the book.
+
+## Code of Conduct
+
+Please note that the ORCESTRA book project is released with a [Contributor Code of Conduct](CONDUCT.md). By contributing to this project you agree to abide by its terms.

README.md

@@ -0,0 +1,18 @@
+# The ORCESTRA book
+
+This repo collects all information to the ORCESTRA campaign in the form of a book. For now, the rendered book (website) is deployed to **https://orcestra-campaign.github.io/book**
+
+The book is thought to grow and include information on
+* the SCIENCE
+* the measurement STRATEGY
+* PREPARATIONS, e.g. the virtual flight campaign
+* DATA, including a data concept, data policy, data access and description
+* and many more...
+
+## Contributing
+
+This is a project from the community for you and for the community and it is under constant improvement. Everyone is welcome to contribute with scripts, ideas, suggestions, by opening issues and making pull requests. More details can be found [here](CONTRIBUTING.md).
+
+## Credits
+
+This project is created using the excellent open source [Jupyter Book project](https://jupyterbook.org/) and the [executablebooks/cookiecutter-jupyter-book template](https://github.com/executablebooks/cookiecutter-jupyter-book).