The Software Engineering PhD Guide

A guide for assisting Software Engineering PhD students. The guide is available online here.

Usage

Building the book

If you'd like to develop and/or build the The Software Engineering PhD Guide book, you should:

1. Clone this repository
2. Run pip install -r requirements.txt (it is recommended you do this within a virtual environment)
3. (Optional) Edit the books source files located in the the_software_engineering_phd_guide/ directory
4. Run jupyter-book clean the_software_engineering_phd_guide/ to remove any existing builds
5. Run jupyter-book build the_software_engineering_phd_guide/

A fully-rendered HTML version of the book will be built in the_software_engineering_phd_guide/_build/html/.

Contributors

We welcome and recognize all contributions. You can see a list of current contributors in the contributors tab.

Credits

This project is created using the excellent open source Jupyter Book project and the executablebooks/cookiecutter-jupyter-book template.