diff --git a/README.md b/README.md index 1b5e6ae..ec09513 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# eo-tides +# eo-tides: Tide modelling tools for Earth Observation [![Release](https://img.shields.io/github/v/release/GeoscienceAustralia/eo-tides)](https://img.shields.io/github/v/release/GeoscienceAustralia/eo-tides) [![Build status](https://img.shields.io/github/actions/workflow/status/GeoscienceAustralia/eo-tides/main.yml?branch=main)](https://github.com/GeoscienceAustralia/eo-tides/actions/workflows/main.yml?query=branch%3Amain) @@ -6,69 +6,5 @@ [![Commit activity](https://img.shields.io/github/commit-activity/m/GeoscienceAustralia/eo-tides)](https://img.shields.io/github/commit-activity/m/GeoscienceAustralia/eo-tides) [![License](https://img.shields.io/github/license/GeoscienceAustralia/eo-tides)](https://img.shields.io/github/license/GeoscienceAustralia/eo-tides) -This is placeholder text. - - **Github repository**: - **Documentation** - -## Getting started with your project - -### 1. Create a New Repository - -First, create a repository on GitHub with the same name as this project, and then run the following commands: - -```bash -git init -b main -git add . -git commit -m "init commit" -git remote add origin git@github.com:GeoscienceAustralia/eo-tides.git -git push -u origin main -``` - -### 2. Set Up Your Development Environment - -Then, install the environment and the pre-commit hooks with - -```bash -make install -``` - -This will also generate your `uv.lock` file - -### 3. Run the pre-commit hooks - -Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run: - -```bash -uv run pre-commit run -a -``` - -### 4. Commit the changes - -Lastly, commit the changes made by the two steps above to your repository. - -```bash -git add . -git commit -m 'Fix formatting issues' -git push origin main -``` - -You are now ready to start development on your project! -The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release. - -To finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi). -For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github). -To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/). - -## Releasing a new version - -- Create an API Token on [PyPI](https://pypi.org/). -- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/GeoscienceAustralia/eo-tides/settings/secrets/actions/new). -- Create a [new release](https://github.com/GeoscienceAustralia/eo-tides/releases/new) on Github. -- Create a new tag in the form `*.*.*`. - -For more details, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/cicd/#how-to-trigger-a-release). - ---- - -Repository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv). diff --git a/README_dev.md b/README_dev.md new file mode 100644 index 0000000..8abc1dd --- /dev/null +++ b/README_dev.md @@ -0,0 +1,61 @@ +## Getting started + +### 1. Create a New Repository + +First, create a repository on GitHub with the same name as this project, and then run the following commands: + +```bash +git init -b main +git add . +git commit -m "init commit" +git remote add origin git@github.com:GeoscienceAustralia/eo-tides.git +git push -u origin main +``` + +### 2. Set Up Your Development Environment + +Then, install the environment and the pre-commit hooks with + +```bash +make install +``` + +This will also generate your `uv.lock` file + +### 3. Run the pre-commit hooks + +Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run: + +```bash +uv run pre-commit run -a +``` + +### 4. Commit the changes + +Lastly, commit the changes made by the two steps above to your repository. + +```bash +git add . +git commit -m 'Fix formatting issues' +git push origin main +``` + +You are now ready to start development on your project! +The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release. + +To finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi). +For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github). +To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/). + +## Releasing a new version + +- Create an API Token on [PyPI](https://pypi.org/). +- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/GeoscienceAustralia/eo-tides/settings/secrets/actions/new). +- Create a [new release](https://github.com/GeoscienceAustralia/eo-tides/releases/new) on Github. +- Create a new tag in the form `*.*.*`. + +For more details, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/cicd/#how-to-trigger-a-release). + +--- + +Repository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv). diff --git a/tox.ini b/tox.ini index 13b858f..e11102a 100644 --- a/tox.ini +++ b/tox.ini @@ -1,10 +1,9 @@ [tox] skipsdist = true -envlist = py38, py39, py310, py311, py312 +envlist = py39, py310, py311, py312 [gh-actions] python = - 3.8: py38 3.9: py39 3.10: py310 3.11: py311