44 lines
2.0 KiB
Markdown
44 lines
2.0 KiB
Markdown
|
# searchme
|
||
|
|
|
||
|
|
[](https://img.shields.io/github/v/release/james/searchme)
|
||
|
|
[](https://github.com/james/searchme/actions/workflows/main.yml?query=branch%3Amain)
|
||
|
|
[](https://codecov.io/gh/james/searchme)
|
||
|
|
[](https://img.shields.io/github/commit-activity/m/james/searchme)
|
||
|
|
[](https://img.shields.io/github/license/james/searchme)
|
||
|
|
|
||
|
|
a mastodon api powered bot that posts terms i search, for better or worse - https://botsin.space/@searchme
|
||
|
|
|
||
|
|
- **Github repository**: <https://github.com/james/searchme/>
|
||
|
|
- **Documentation** <https://james.github.io/searchme/>
|
||
|
|
|
||
|
|
## Getting started with your project
|
||
|
|
|
||
|
|
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:james/searchme.git
|
||
|
|
git push -u origin main
|
||
|
|
```
|
||
|
|
|
||
|
|
Finally, install the environment and the pre-commit hooks with
|
||
|
|
|
||
|
|
```bash
|
||
|
|
make install
|
||
|
|
```
|
||
|
|
|
||
|
|
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 or Artifactory, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/publishing/#set-up-for-pypi).
|
||
|
|
For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/mkdocs/#enabling-the-documentation-on-github).
|
||
|
|
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/codecov/).
|
||
|
|
|
||
|
|
## Releasing a new version
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
Repository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).
|