Skip to content

Contribution instructions #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TinasheMTapera merged 1 commit into from
Jul 3, 2025
Merged

Contribution instructions #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# National Studies on Air Pollution and Health Software

This repo builds the NSAPH Software website, which is a collection of open-source packages to carry out **N**ational **S**tudies on **A**ir **P**ollution and **H**ealth.

To contribute to the website, please run the following:

```bash
# clone this repository
git clone https://github.com/NSAPH-Software/nsaph-software.github.io.git

# change directory to the cloned repository
cd nsaph-software.github.io

# install the required packages
conda install -f env_dev.yml

# build the website using make
make
```

Importantly, the make command will build the website and also go through the process of copying the build files to the `docs` directory, which is where GitHub Pages will serve the content from.

To preview the website locally, you can simply open the file `docs/index.html` in your web browser once the `make` command has completed.