Skip to content

Commit 5f009e8

Browse files
committed
Update installation instructions and remove unnecessary sections in README.md
1 parent a6b9219 commit 5f009e8

File tree

1 file changed

+3
-31
lines changed

1 file changed

+3
-31
lines changed

README.md

Lines changed: 3 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -11,40 +11,12 @@ Hyperelastic Surrogates
1111
- **Github repository**: <https://github.com/jpsferreira/hyper-surrogate/>
1212
- **Documentation** <https://jpsferreira.github.io/hyper-surrogate/>
1313

14-
## Getting started with your project
15-
16-
First, create a repository on GitHub with the same name as this project, and then run the following commands:
17-
18-
```bash
19-
git init -b main
20-
git add .
21-
git commit -m "init commit"
22-
git remote add origin [email protected]:jpsferreira/hyper-surrogate.git
23-
git push -u origin main
24-
```
25-
26-
Finally, install the environment and the pre-commit hooks with
14+
## Installation
2715

2816
```bash
29-
make install
17+
pip install hyper-surrogate
3018
```
3119

32-
You are now ready to start development on your project!
33-
The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.
34-
35-
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).
36-
For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/mkdocs/#enabling-the-documentation-on-github).
37-
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/codecov/).
38-
39-
## Releasing a new version
40-
41-
- Create an API Token on [Pypi](https://pypi.org/).
42-
- 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).
43-
- Create a [new release](https://github.com/jpsferreira/hyper-surrogate/releases/new) on Github.
44-
- Create a new tag in the form `*.*.*`.
45-
46-
For more details, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/cicd/#how-to-trigger-a-release).
47-
48-
---
20+
## Usage
4921

5022
jpsferreira

0 commit comments

Comments
 (0)