Skip to content
Snippets Groups Projects
Commit bbb1ae37 authored by Felipe Delestro Matos's avatar Felipe Delestro Matos
Browse files

basic example

parent e0b3b98c
No related branches found
No related tags found
No related merge requests found
......@@ -7,5 +7,21 @@ At this stage the project is still exploratory and not exactly meant for third-p
It is recommended to have:
- README.md
- .gitignore
- Directory for code
- Directories for organization
## Basic usage
Your functions can be imported as a library if the directory contains a `__init__.py` file. Check in this repository the `example_basic` directory for example.
It is possible to use your library **without installation**, if the Python kernel is started at the root folder of the repository.
``` python
fima@pop-os ~/example-repositories/example-repository-basic $ python
Python 3.10.12 (main, Jun 11 2023, 05:26:28) [GCC 11.4.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import example_basic
>>> example_basic.examples.first_example()
This is the first example
```
......@@ -4,7 +4,11 @@ In the `docs` directory we can add extended documentation about the repository
This is a good place for more detailed descriptions that would make the readme fille too long.
Small images used to illustrate the documentation can be added to the `docs/img/` directory:
## Images
![image](img/blobs_256x256.tif)
Small images used to illustrate the documentation can be added to the `docs/img/` directory.
As example, here's an image of DTU Compute building:
![DTU Compute](img/DTU-Compute.jpg)
`
\ No newline at end of file
docs/img/DTU-Compute.jpg

191 KiB

File deleted
from example_basic import examples
\ No newline at end of file
def first_example():
print ("This is the first example")
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment