Skip to content

Commit

Permalink
Adding small statement about WSL.
Browse files Browse the repository at this point in the history
  • Loading branch information
jlconlin committed Jan 11, 2021
1 parent c81775f commit 8ab6e57
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
@@ -1,5 +1,13 @@
# readthedocs
This repository contains the top-level documentation for NJOY21. It is best viewed at [docs.njoy21.io](https://docs.njoy21.io).

## Building
This documentation uses [Sphinx](https://sphinx-doc.org) to build and serve the documentation. You can build and serve the documentation locally

```console
sphinx-autobuild docs docs/_build/html --port=4001
```
Then just go to [localhost:4001](localhost:4001) and you can see the documentation.

## LICENSE
This software is copyrighted by Los Alamos National Laboratory and distributed according to the conditions in the accompanying [LICENSE](LICENSE) file.
4 changes: 4 additions & 0 deletions docs/install.rst
Expand Up @@ -41,6 +41,10 @@ build system and `git <https://git-scm.com>`__ for version control.
- `CMake 3.2+ <https://cmake.org/>`__
- `git 2.1+ <https://git-scm.com>`__

Windows
-------
When building on Windows, we only support using the [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/). The build system is the same.

Build Process
=============

Expand Down

0 comments on commit 8ab6e57

Please sign in to comment.