Skip to content
This repository has been archived by the owner on Jun 2, 2022. It is now read-only.

Commit

Permalink
Add reqs and up-and-running info to README
Browse files Browse the repository at this point in the history
  • Loading branch information
dwinston committed Jan 23, 2019
1 parent b379894 commit 2e42371
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 1 deletion.
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,31 @@ https://github.com/materialsproject/docs/issues/new) or suggest an
edit to us via a Pull Request.

Thanks,
Materials Project Team
Materials Project Team

# Contributing

We use [MkDocs](https://www.mkdocs.org/), a static site generator for project documentation. We also use the
[mkdocs-material](https://squidfunk.github.io/mkdocs-material/) theme for styling.

## Up and running

Fork this repository and then clone it to your computer.

Create a Python 3 environment for this project and activate it. Example flow using `conda`:
```
$ conda create -n mpdocs python=3
$ conda activate mpdocs
```
Navigate to the folder of your cloned repository, and install dependencies:
```
(mpdocs)$ pip install -r requirements.txt
```
Start the development server:
```
(mpdocs)$ mkdocs serve
```
Open [http://127.0.0.1:8000/]( http://127.0.0.1:8000/) to preview the site and see changes as you make them.

Create a new git branch to record any changes. When you push your branch to GitHub, you can then initiate a Pull
Request against the `master` branch of this repo.
2 changes: 2 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
mkdocs==1.0.4
mkdocs-material==3.2.0

0 comments on commit 2e42371

Please sign in to comment.