Skip to content

Commit 31f15c6

Browse files
author
Brad Crawford
committed
made README.md headers larger
1 parent 983e900 commit 31f15c6

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1-
## github_tutorial
1+
# github_tutorial
22

3-
### Overview
3+
## Overview
44

55
This is a basic github repository to show a Github structure, docstrings, and test codes via pytest.
66

7-
### Documentation
7+
8+
## Documentation
89

910
To be added in the future.
1011

11-
### Installation
12+
13+
## Installation
1214

1315
The github_tutorial package dependencies can be installed via conda, and this package tagged in conda via pip install:
1416

@@ -26,7 +28,7 @@ Note: If you update the conda package, you may have to redo the pip install. Wi
2628

2729
`pip install -e .`
2830

29-
### Run the example
31+
## Run the example
3032

3133
This is an example of the supplimentary functions in the utils directory (github_tutorial/utils) and the main function in the main_functions directory (github_tutorial/main_functions).
3234

@@ -36,14 +38,14 @@ The example is located here 'examples_to_run/examples.py'. The instructions to r
3638

3739
`python examples.py`
3840

39-
### Run the interactive example in Visual Studios Code (VScode)
41+
## Run the interactive example in Visual Studios Code (VScode)
4042

4143
This is the same example but running it as an interactive job (i.e., like a Jupyter notebook). The example is located here 'examples_to_run/interactive_examples.py'.
4244

4345
When using Visual Studios Code (VScode), the '# %%' above each section makes it a cell, which can be run individually by holding shift and pressing enter.
4446

4547

46-
### Run the test cases using pytest
48+
## Run the test cases using pytest
4749

4850
Each python file has it's own test functions scripts located here 'github_tutorial/tests', which are used to ensure proper functionallity when making changes to the code, or if python dependancies alter how some functions behave.
4951

0 commit comments

Comments
 (0)