Skip to content

README.md

Latest commit

 

History

History
69 lines (49 loc) · 2.55 KB

README.md

File metadata and controls

69 lines (49 loc) · 2.55 KB

App Dev for All: Intro to Java Programming

App Dev for All's introductory course in Java programming for Android. This repository is the source for the course, in Markdown format. It can be generated into a PDF or HTML pages using scripts.

Setup

Prerequisites

This course is distributed from source as a Python project. This allows the definition of Python scripts to convert the course to HTML or PDF using Python libraries. You must have Python 3.9+ installed to build the course from source.

After ensuring that Python is installed, continue with the rest of the setup, either using Hatch (recommended) or using a virtual environment.

Recommended Setup, Using Hatch

You can install Hatch in a virtual environment, if you want. However, since Hatch is the only prerequisite, and since it sets up virtual environments automatically when building, starting shells, or running scripts, I don't find that it's necessary. That is, Hatch is the only thing I install in the global environment.

  1. Install Hatch: pip install hatch
    (Or pip install --user hatch if you prefer)

Once Hatch is installed, there is no setup required when you return working on the project.

Alternate Install, without Hatch

  1. Create a virtual environment: pip -m venv venv
  2. Enter the virtual environment: source venv/bin/activate
    (Windows: venv/bin/activate)
  3. Install the package: pip install -e .

For subsequence use, just go to the package directory and enter the virtual environment: source venv/bin/activate
(Windows: venv/bin/activate)

Viewing or converting the course

While editing the content, it is convienient to convert the course to HTML, then open index.html as a file in the browser. After making changes, re-generate the HTML and refresh the browser window to see the changes.

If using Hatch

  • Converting content to HTML in dist/html/: hatch run course:html
    Then open: site/index.html
  • Converting content to a PDF in site/: hatch run course:pdf\

You can also view the content from a mkdocs web server. However, auto-update after changes does not seem to be working, so this is less convenient than converting to HTML and loading from a file URL.

If not using Hatch

First, start the virtual environment as indicated above.

  • Viewing content as HTML: mkdocs serve
  • Converting content to a PDF in dist/: `python ad4a.util.genpdf:main mkdocs.yml dist/intro-to-programming.pdf``
  • Converting content to HTML in site/: mkdocs build