Skip to content

Commit b24e810

Browse files
committed
📝 update instructions on what to replace
1 parent 25751e1 commit b24e810

File tree

3 files changed

+12
-3
lines changed

3 files changed

+12
-3
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,14 @@
55
Can be used as GitHub template repository,
66
see [GitHub documentation](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).
77

8-
You will need to find and replace occurences of `mockup` with the name of your package. This still might
8+
You will need to find and replace occurences of
9+
10+
- `mockup` -> `your_package_name`
11+
- `rasmussenlab-mockup` -> `your_package_name`
12+
- `RasmussenLab` -> `GitHub_user_name` (or organization)
13+
- `python_package` -> `your_package_name`
14+
15+
with the name of your package and GitHub user name (or organization). This still might
916
need further testing:
1017

1118
```bash

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Install the docs dependencies of the package (as speciefied in toml):
1212

1313
```bash
1414
# in main folder
15-
pip install .[docs]
15+
pip install ".[docs]"
1616
```
1717

1818
## Build docs using Sphinx command line tools
@@ -28,4 +28,4 @@ Options:
2828
sphinx-apidoc --force --implicit-namespaces --module-first -o reference ../src/mockup
2929
# build docs
3030
sphinx-build -n -W --keep-going -b html ./ ./_build/
31-
```
31+
```

pyproject.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ classifiers = [
1717
"License :: OSI Approved :: MIT License",
1818
"Operating System :: OS Independent",
1919
]
20+
# # add dependencies here:
21+
# dependencies = ["numpy", "pandas", "scipy", "matplotlib", "seaborn"]
2022

2123
[project.urls]
2224
"Bug Tracker" = "https://github.com/RasmussenLab/python_package/issues"

0 commit comments

Comments
 (0)