Skip to content

Commit

Permalink
Update installation instructions and remove unnecessary sections in R…
Browse files Browse the repository at this point in the history
…EADME.md
  • Loading branch information
jpsferreira committed Apr 11, 2024
1 parent a6b9219 commit 5f009e8
Showing 1 changed file with 3 additions and 31 deletions.
34 changes: 3 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,40 +11,12 @@ Hyperelastic Surrogates
- **Github repository**: <https://github.com/jpsferreira/hyper-surrogate/>
- **Documentation** <https://jpsferreira.github.io/hyper-surrogate/>

## 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 [email protected]:jpsferreira/hyper-surrogate.git
git push -u origin main
```

Finally, install the environment and the pre-commit hooks with
## Installation

```bash
make install
pip install hyper-surrogate
```

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

- 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/jpsferreira/hyper-surrogate/settings/secrets/actions/new).
- Create a [new release](https://github.com/jpsferreira/hyper-surrogate/releases/new) on Github.
- Create a new tag in the form `*.*.*`.

For more details, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/cicd/#how-to-trigger-a-release).

---
## Usage

jpsferreira

0 comments on commit 5f009e8

Please sign in to comment.