Skip to content

Commit

Permalink
📝 update instructions on what to replace
Browse files Browse the repository at this point in the history
  • Loading branch information
enryH committed Sep 9, 2024
1 parent 25751e1 commit b24e810
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 3 deletions.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,14 @@
Can be used as GitHub template repository,
see [GitHub documentation](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).

You will need to find and replace occurences of `mockup` with the name of your package. This still might
You will need to find and replace occurences of

- `mockup` -> `your_package_name`
- `rasmussenlab-mockup` -> `your_package_name`
- `RasmussenLab` -> `GitHub_user_name` (or organization)
- `python_package` -> `your_package_name`

with the name of your package and GitHub user name (or organization). This still might
need further testing:

```bash
Expand Down
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Install the docs dependencies of the package (as speciefied in toml):

```bash
# in main folder
pip install .[docs]
pip install ".[docs]"
```

## Build docs using Sphinx command line tools
Expand All @@ -28,4 +28,4 @@ Options:
sphinx-apidoc --force --implicit-namespaces --module-first -o reference ../src/mockup
# build docs
sphinx-build -n -W --keep-going -b html ./ ./_build/
```
```
2 changes: 2 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ classifiers = [
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
]
# # add dependencies here:
# dependencies = ["numpy", "pandas", "scipy", "matplotlib", "seaborn"]

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

0 comments on commit b24e810

Please sign in to comment.