diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 5fe2f65fe..7c15e3865 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -3,10 +3,10 @@ name: CI on: push: branches: - - master + - main pull_request: branches: - - master + - main types: - opened - reopened diff --git a/.github/workflows/screenshots.yml b/.github/workflows/screenshots.yml index d4cfb94d3..40f55d234 100644 --- a/.github/workflows/screenshots.yml +++ b/.github/workflows/screenshots.yml @@ -3,7 +3,7 @@ name: Screenshots on: pull_request: branches: - - master + - main types: - opened - reopened diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e76c4c21c..7bf5c69ea 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contribution guide -Contributions are welcome! +Contributions are welcome! :smile: ## Instructions @@ -18,18 +18,18 @@ cd fastplotlib pip install -e ".[notebook,docs,tests] ``` -3. Checkout the `master` branch, and then checkout your feature or bug fix branch, and run tests: +3. Checkout the `main` branch, and then checkout your feature or bug fix branch, and run tests: > **Warning** > Do not commit or add any changes from `examples/screenshots` or `examples/diffs`. -> If you are creating new test examples that generate or change screenshots please post an issue on the repo and we will help you. +> If you are creating new test examples that generate or change screenshots please post an issue on the repo and we will help you. The screenshots will be generated on github actions servers, which you can then copy into the screenshots dir. :) ```bash cd fastplotlib -git checkout master +git checkout main -# checkout your new branch from master +# checkout your new branch from main git checkout -b my-new-feature-branch # make your changes @@ -49,4 +49,4 @@ git commit -m "my new feature" git push origin my-new-feature-branch ``` -4. Finally make a **draft** PR against the `master` branch. When you think the PR is ready, mark it for review to trigger tests using our CI pipeline. If you need to make changes, please set the PR to a draft when pushing further commits until it's ready for review scion. We will get back to your with any further suggestions! +4. Finally make a **draft** PR against the `main` branch. When you think the PR is ready, mark it for review to trigger tests using our CI pipeline. If you need to make changes, please set the PR to a draft when pushing further commits until it's ready for review scion. We will get back to your with any further suggestions! diff --git a/README.md b/README.md index 8002f7100..f2b788156 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ A fast plotting library built using the [`pygfx`](https://github.com/pygfx/pygfx http://fastplotlib.readthedocs.io/ -The Quickstart guide is not interactive. We recommend cloning/downloading the repo and trying out the `desktop` or `notebook` examples: https://github.com/kushalkolar/fastplotlib/tree/master/examples +The Quickstart guide is not interactive. We recommend cloning/downloading the repo and trying out the `desktop` or `notebook` examples: https://github.com/kushalkolar/fastplotlib/tree/main/examples If someone wants to integrate `pyodide` with `pygfx` we would be able to have live interactive examples! :smiley: @@ -83,7 +83,7 @@ pip install -e ".[notebook,docs,tests]" > **Note** > -> `fastplotlib` and `pygfx` are fast evolving, you may require the latest `pygfx` and `fastplotlib` from github to use the examples in the master branch. +> `fastplotlib` and `pygfx` are fast evolving, you may require the latest `pygfx` and `fastplotlib` from github to use the examples in the main branch. Note that `fastplotlib` code is basically identical between desktop and notebook usage. The differences are: - Running in `Qt` or `glfw` require a `fastplotlib.run()` call (which is really just a `wgpu` `run()` call) @@ -93,7 +93,7 @@ Note that `fastplotlib` code is basically identical between desktop and notebook Desktop examples are here: -https://github.com/fastplotlib/fastplotlib/tree/master/examples/desktop +https://github.com/fastplotlib/fastplotlib/tree/main/examples/desktop Some of the examples require imageio: ``` @@ -104,7 +104,7 @@ pip install imageio Notebook examples are here: -https://github.com/fastplotlib/fastplotlib/tree/master/examples/notebooks +https://github.com/fastplotlib/fastplotlib/tree/main/examples/notebooks **Start with `simple.ipynb`.** @@ -152,6 +152,6 @@ As far as I know, WGPU uses Metal instead of Vulkan on Mac. You will need at lea # :heart: Contributing -We welcome contributions! See the contributing guide: https://github.com/kushalkolar/fastplotlib/blob/master/CONTRIBUTING.md +We welcome contributions! See the contributing guide: https://github.com/kushalkolar/fastplotlib/blob/main/CONTRIBUTING.md You can also take a look at our [**Roadmap for 2023**](https://github.com/kushalkolar/fastplotlib/issues/55) and [**Issues**](https://github.com/kushalkolar/fastplotlib/issues) for ideas on how to contribute! diff --git a/docs/source/conf.py b/docs/source/conf.py index 77bd6be62..7b33a309e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -57,6 +57,6 @@ html_theme_options = { "source_repository": "https://github.com/kushalkolar/fastplotlib", - "source_branch": "master", + "source_branch": "main", "source_directory": "docs/", } pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy