Skip to content

Commit

Permalink
- added README to examples and pointed automated opening setting to i…
Browse files Browse the repository at this point in the history
…t to not open Jupyter directly as a plain text
  • Loading branch information
amkrajewski committed Jan 29, 2024
1 parent 7bbf766 commit 7e47b58
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"customizations": {
"codespaces": {
"openFiles": [
"examples/quickstart.ipynb"
"examples/README.md"
]
},
"vscode": {
Expand Down
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,7 @@ htmldocs/
*.so
*.pyd
.DS_Store
smallTest.ipynb
smallTest.ipynb
# Example Output Files
examples/gridForAda.txt
examples/gridForJulia.npy
4 changes: 4 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Quick Start

This is a quick start guide to get you up and running with the nimplex software. If you are running it in the Codespaces environment, you should now open the
[**`quickstart.ipynb`**](quickstart.ipynb) notebook inside this directory and follow the instructions there. **Please note, once propted to select a kernel (after running the first code cell), you should select the `base` kernel (which should show up as recommended).**

0 comments on commit 7e47b58

Please sign in to comment.