You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,14 +30,14 @@ pip install necbol
30
30
## User Guide
31
31
Documentation is work in progress. In the meantime:
32
32
33
-
* For a quick and basic overview, see the file "example_dipole_with_detailed_comments.py" for a minimal explanation of how to use this framework.
33
+
* For a quick and basic overview, see the file **"example_dipole_with_detailed_comments.py"** in the examples folder for a minimal explanation of how to use this framework.
34
34
35
35
* There are several more example files in the [examples folder](https://github.com/G1OJS/NECBOL/tree/main/examples) intended to highlight different aspects of necbol and different ways of doing similar things. You can copy these examples and modify to see how they work, or start your own from scratch.
36
36
37
37
* Automated user documentation is [here](https://g1ojs.github.io/NECBOL/docs/user_functions.html). You can see an outline of all code [here](https://g1ojs.github.io/NECBOL/docs/outline.html).
38
38
39
39
* You can browse the source files in the [necbol folder](https://github.com/G1OJS/NECBOL/tree/main/necbol) (however note that they may be ahead of the release on pip).
40
40
41
-
* Please look at the change history file, especally if you've used previous versions
41
+
* Please look at the [change history](https://g1ojs.github.io/NECBOL/change-history), especally if you've used previous versions
42
42
43
43
* Note that the TO_DO list has been deleted and captured in GitHub issues
0 commit comments