Basic Info

The webpage is hosted on bioinformaticscrashcourse.com.

Instructions

Setup

To get started, you need to:

1. Clone this GitHub repository to your local machine
2. Run make html in the project's parent directory, which will create the website using the .md files. If this works*, you're all set! If this does not, continue to the next step.
3. Run pip install sphinx, then run pip install recommonmark, and finally run pip install sphinx-rtd-theme. Try running make html again. If this fails, ask a previous crash course developer to help you troubleshoot.

* "works" means that you get the message: The HTML pages are in build/html.. Warnings are expected and don't need to be corrected.

Development (the easy way)

To create a new lesson you need to perform the following steps directly on GitHub:

1. Create a new .md file under the source directory. You should name it something like #_LessonName.md.
2. Open index.rst and add the name of the .md file you created to the existing list. You should keep About This Course as the last entry in the list. Keep in mind that indentation matters!
3. Edit your new .md file directly on GitHub. You'll be able to see what it looks like in Markdown format after saving, which is very similar to how it will render on the website.

Development (the hard way)

To create a new lesson you need to perform the following steps on your local machine:

1. Create a new .md file under the source directory. You should name it something like #_LessonName.md.
2. Open index.rst and add the name of the .md file you created to the existing list. You should keep About This Course as the last entry in the list. Keep in mind that indentation matters!
3. Create your lesson in the .md file. When you want to view your changes, run make html in the project's parent directory (above source). This will generate .html files in the build directory. You can open these files in a web browser to view them.
4. Once you are completely done developing a lesson, push your changes to GitHub. The web server will automatically register the changes and rebuild. (It might take a few minutes for the website to update.)

Please do not change the About This Course page without consulting Sabeel!