Skip to content

Commit

Permalink
Cleaned up readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bartvanb committed Apr 8, 2024
1 parent a5ab43e commit 9f73693
Showing 1 changed file with 4 additions and 19 deletions.
23 changes: 4 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,33 +11,18 @@ The base code for this algorithm has been created via the
[v6-algorithm-template](https://github.com/vantage6/v6-algorithm-template)
template generator.

### Checklist

Note that the template generator does not create a completely ready-to-use
algorithm yet. There are still a number of things you have to do yourself.
Please ensure to execute the following steps. The steps are also indicated with
TODO statements in the generated code - so you can also simply search the
code for TODO instead of following the checklist below.

- [] Fill in the documentation template. This will help others to understand your
algorithm, be able to use it safely, and to contribute to it.
- [] If you want to submit your algorithm to a vantage6 algorithm store, be sure
to fill in everything in ``algorithm_store.json`` (and be sure to update
it if you change function names, arguments, etc.).
- [] Finally, remove this checklist section to keep the README clean.

### Dockerizing your algorithm
## Dockerizing your algorithm

To finally run your algorithm on the vantage6 infrastructure, you need to
create a Docker image of your algorithm.

#### Automatically
### Automatically

The easiest way to create a Docker image is to use the GitHub Actions pipeline to
automatically build and push the Docker image. All that you need to do is push a
commit to the ``main`` branch.

#### Manually
### Manually

A Docker image can be created by executing the following command in the root of your
algorithm directory:
Expand Down Expand Up @@ -71,4 +56,4 @@ the image. You can do this by running `docker login` and providing your
credentials. Check [this page](https://docs.docker.com/get-started/04_sharing_app/)
For more details on sharing images on Docker Hub. If you are using a different
Docker registry, check the documentation of that registry and be sure that you
have sufficient permissions.
have sufficient permissions.

0 comments on commit 9f73693

Please sign in to comment.