Skip to content

Commit 4d64446

Browse files
committed
1 parent c3dea19 commit 4d64446

28 files changed

+9
-2731
lines changed

README.md

+9
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,15 @@ For a much more detailed overview, please see
9696
test # run tests
9797
```
9898

99+
### Documentation
100+
101+
The docs are maintained in a dedicated repo [WannierDocs.jl](https://github.com/qiaojunfeng/WannierDocs.jl).
102+
This allows us to add large tutorial files (e.g. `amn`, `mmn`) without bloating the main repo.
103+
Furthermore, it also contains the docs for another two packages:
104+
105+
- [WannierIO.jl](https://github.com/qiaojunfeng/WannierIO.jl) for reading and writing files
106+
- [WannierPlots.jl](https://github.com/qiaojunfeng/WannierPlots.jl) for plotting band structure, etc.
107+
99108
## Contributing
100109

101110
The code initially started with Antoine Levitt's repo

docs/.gitignore

-1
This file was deleted.

docs/Project.toml

-16
This file was deleted.

docs/README.md

-23
This file was deleted.

docs/make.jl

-90
This file was deleted.

docs/src/.gitignore

-2
This file was deleted.

docs/src/api/bvector.md

-60
This file was deleted.

docs/src/api/cli.md

-27
This file was deleted.

0 commit comments

Comments
 (0)