Skip to content
Snippets Groups Projects
Unverified Commit 4d9a12ed authored by eliselavy's avatar eliselavy Committed by GitHub
Browse files

Update README.md

parent 4556e708
No related branches found
No related tags found
No related merge requests found
...@@ -15,6 +15,11 @@ The preflight action generates a report within the repository that contains info ...@@ -15,6 +15,11 @@ The preflight action generates a report within the repository that contains info
The preflight action generates or updates a report markdown file in the repository that provides information about the adherence of the article to the submission guidelines, usually named `report.md` The preflight action generates or updates a report markdown file in the repository that provides information about the adherence of the article to the submission guidelines, usually named `report.md`
`requirements.txt` - stores information about all the libraries, modules, and packages in itself that are used while developing a particular project.
`runtime.txt` - specify the version of the runtime (e.g. the version of Python ). Have python-x.y in runtime.txt to run the repository with Python version x.y
## Getting Started ## Getting Started
This repository it's a _template_, that is, it can be used as a starting point for new repositories. This repository it's a _template_, that is, it can be used as a starting point for new repositories.
...@@ -38,7 +43,7 @@ The preflight action will generate a report in the repository that provides info ...@@ -38,7 +43,7 @@ The preflight action will generate a report in the repository that provides info
## MyBinder ## MyBinder
The repository also contains a `requirements.txt` file that can be used to create a MyBinder environment. Check: https://mybinder.readthedocs.io/en/latest/using/config_files.html#preparing-a-repository-for-binder The repository also contains a `requirements.txt` and a `runtime.txt` file that can be used to create a MyBinder environment. Check: https://mybinder.readthedocs.io/en/latest/using/config_files.html#preparing-a-repository-for-binder
The MyBinder environment can be used to run the example notebook to test that the code runs smoothly. The MyBinder environment can be used to run the example notebook to test that the code runs smoothly.
## Contribution Guidelines ## Contribution Guidelines
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment