Skip to content

Commit

Permalink
fix formats and links in README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
yalinli2 authored Oct 22, 2023
1 parent 4d591d5 commit 2abe8a0
Showing 1 changed file with 16 additions and 15 deletions.
31 changes: 16 additions & 15 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,34 +3,37 @@ QSDedu: Education modules for Quantitative Sustainable Design
=============================================================

.. image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/gh/QSD-group/QSDedu/main
:target: https://mybinder.org/v2/gh/QSD-Group/QSDsan-env/main?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252FQSD-group%252FQSDedu%26urlpath%3Dtree%252FQSDedu%252F%26branch%3Dmain

.. GitHub test of the main branch
.. image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/gh/QSD-Group/QSDsan-env/main?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252FQSD-group%252FQSDedu%26urlpath%3Dtree%252FQSDedu%252F%26branch%3Dmain
.. image:: https://github.com/QSD-Group/QSDedu/actions/workflows/build.yml/badge.svg?branch=main
:target: https://github.com/QSD-Group/QSDsan/actions/workflows/build.yml

.. Status
.. image:: https://img.shields.io/badge/status-under%20development-blue?style=flat


Launching Binder
----------------
Method 1
********
Directly click the |_binder_badge| above to launch binder in your browser.

.. |_binder_badge| image:: https://mybinder.org/badge_logo.svg

Method 2
********
If it takes a long time (or it times out), go to https://mybinder.org, enter the information as below:

* GitHub: https://github.com/QSD-Group/QSDedu
* Git ref: main
* GitHub: ``https://github.com/QSD-Group/QSDedu``
* Git ref: ``main``

and click the `launch` button.

.. image:: ./images/launch_binder.png
.. image:: images/launch_binder.png
:width: 60%


Status
------
.. image:: https://img.shields.io/badge/status-under%20development-blue?style=flat

This repository is under continuous development, please refer to the individual README files within each module for its status.


What is QSDedu?
---------------
QSDedu contains course modules for quantitative sustainable design (QSD), including the introduction of QSD methodology [1]_ and separate modules on using the packages developed by the `Quantitative Sustainable Design Group <https://github.com/QSD-Group>`_ for QSD of different engineered systems.
Expand All @@ -53,5 +56,3 @@ Please refer to the ``LICENSE.txt`` for information on the terms & conditions fo
References
----------
.. [1] Li, Y.; Trimmer, J.T.; Hand, S.; Zhang, X.; Chambers, K.G.; Lohman, H.A.C.; Shi, R.; Byrne, D.M.; Cook, S.M.; Guest, J.S. Quantitative Sustainable Design (QSD): A Methodology for the Prioritization of Research, Development, and Deployment of Technologies. (Tutorial Review) Environ. Sci.: Water Res. Technol. 2022, 8 (11), 2439–2465. https://doi.org/10.1039/D2EW00431C.
.. _binder_badge: https://mybinder.org/badge_logo.svg

0 comments on commit 2abe8a0

Please sign in to comment.