Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed release, update some infomations #4

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
2 changes: 1 addition & 1 deletion .github/workflows/release(manually).yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ jobs:
git config --global user.name "Auto commit (Github release workflow)"
git config --global user.email "[email protected]"
git add .
git commit -m "commit by auto commit"
git commit -m "commit by auto commit (Github release workflow)"
fi
git tag $VERSION
git push origin $VERSION main
Expand Down
4 changes: 2 additions & 2 deletions docs/readme_repo.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@

1. Install from PyPI
```shell
pip install <package-name>
pip install blochsimu
```

1. Download the latest release from {{insert_point.github_release}}
```shell
pip install <package-name>-{{insert_point.version}}.tar.gz
pip install blochsimu-{{insert_point.version}}.tar.gz
```

## Usage
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ maintainers = [
{ name="ElenBOT", email="[email protected]"},
]
description = "Simulate and plot the behavior of a qubit on bloch sphere"
readme = "readme.md"
readme = "README.md"
requires-python = ">=3.7"
dependencies = [
"numpy",
Expand All @@ -25,7 +25,7 @@ classifiers = [
"Programming Language :: Python :: 3",
"Topic :: Scientific/Engineering :: Physics",
"Operating System :: OS Independent",
# License
"License :: OSI Approved :: MIT License",
]

[project.urls]
Expand Down
22 changes: 0 additions & 22 deletions readme.md

This file was deleted.

2 changes: 1 addition & 1 deletion version.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ def get_file_text(self):
f.write(_CHANGELOG_TEMPLATE)

# Create readme.md
with open("docs/readme_repo.md", "r", encoding='utf-8') as f:
with open("docs/README_repo.md", "r", encoding='utf-8') as f:
file_obj = Insert(f.read())
# point 0
content_p0 = f"[Release {version}](https://github.com/ElenBOT/simulation-of-a-qubit-on-bloch-sphere/releases/tag/{version})"
Expand Down