@@ -19,33 +19,6 @@ The GitHub repo where the source code can be found is: [github.com/ChrisWoodgate
1919
2020---
2121
22- ## 🧭 Documentation Guide
23-
24- - ** Modules** — High-level structure of the project
25- - ** Modules List** – List of modules
26- - ** Module Members** – Complete list of members of * all* modules
27- - ** Data Types** — Derived types/classes used in the project
28- - ** Files** — Browse the project's file structure
29-
30- ---
31-
32- ## 📁 Project Structure
33-
34- <pre >
35- BraWl/
36- ├── src/ # Core source code
37- ├── include/ # Any header files
38- ├── examples/ # Examples of use
39- ├── tests/ # Test cases
40- ├── docs/ # Documentation (this!)
41- ├── README.md # High-level overview and README
42- ├── Makefile # Makefile (for building the code!)
43- ├── LICENSE.txt # Copyright statement and license (LGPL-3.0)
44- └── CODE_OF_CONDUCT.md # Contributor Covenant Code of Conduct
45- </pre >
46-
47- ---
48-
4922## 📝 Citation
5023
5124If you use ** BraWl** in your research, please cite our preprint:
@@ -94,3 +67,30 @@ Any/all contributions are welcome via pull requests.
9467## 🪪 License
9568
9669This software is released under the LGPL-3.0 license. See the file LICENSE.txt for details.
70+ ---
71+
72+ ## 🧭 Documentation Guide
73+
74+ - ** Modules** — High-level structure of the project
75+ - ** Modules List** – List of modules
76+ - ** Module Members** – Complete list of members of * all* modules
77+ - ** Data Types** — Derived types/classes used in the project
78+ - ** Files** — Browse the project's file structure
79+
80+ ---
81+
82+ ## 📁 Project Structure
83+
84+ <pre >
85+ BraWl/
86+ ├── src/ # Core source code
87+ ├── include/ # Any header files
88+ ├── examples/ # Examples of use
89+ ├── tests/ # Test cases
90+ ├── docs/ # Documentation (this!)
91+ ├── README.md # High-level overview and README
92+ ├── Makefile # Makefile (for building the code!)
93+ ├── LICENSE.txt # Copyright statement and license (LGPL-3.0)
94+ └── CODE_OF_CONDUCT.md # Contributor Covenant Code of Conduct
95+ </pre >
96+
0 commit comments