The home page shows the layout and general idea of the color choices, materials, fittings and furnishings in a format viewable from modern web browsers (Chrome and Edge have been tested). SweetHome 3D Home Plan contains the native drawing format, available from the GitHub project site.

See Third party notices for the free and open source software required to view/edit the Home Plan and CAD drawings.

The Makefile builds a printable PDF. The PDF defaults to KOMA-Script scrartcl, specified in the .mdpp files' YAML meta-data. Refer to the Makefile for build software.

# Create PDF in print/ folder.
make pdf

The Makefile builds HTML5 files with a JavaScript viewer of the Sweet Home 3d plan. A Sweet Home 3d plugin is required to generate the JavaScript viewer. See Third Party Notices for information about downloading the plugin. Refer to the Makefile for build software.

The Makefile generates the web site in the docs/ folder and publishes to the GitHub pages site.

# Create HTML5 for review in docs/ folder.
make html

# Run local web server for document review.
# Open the resulting URL with Edge or Chrome.
python -m http.server --bind localhost 8000 --directory docs/ &

# Publish to GitHub Pages, regenerating the docs/ folder, if needed.
make publish

Update the remodel variable in the Makefile to change the location. htmloutput, staticoutput, templates and staticobjects may also need adjusting if your static web page server has a different folder layout than GitHub Pages

When sharing the PDF, generated by make pdf with a contractor, it is helpful to highlight changes. difftoolpdf.sh generates a PDF using PDF comments to mark changes.

Usage: difftoolpdf.sh <old> [<new>]

Old and new can be any commit reference recognized by git checkout.
E.g., difftoolpdf.sh v1.0 v1.1
If <new> is omitted, use the current branch & commit.

Recommend tagging the commit that is shared with the contractor, e.g.,
git tag v1.0. Append the commit ID if the tag isn't for the current commit.

The make file relies on several tools, available through a conda environment specified in environment.yml. To create the necessary environment, isolated from system versions, environment.yml may be used to create a conda environment called Remodel.

• Install Anaconda3 or Miniconda3. Pandoc and link_filter.py were tested using Python 3.

• From a bash prompt, enter conda env create --file environment.yml.

• Follow the instructions in the output to conda activate Remodel.

Richland_Prefab_2BR.mdpp contains an overview of the project and defines the content for the PDF and HTML5 versions.

Lighting, wiring, outlets and irrigation controls are discussed below.

Electrical Upgrade

Plumbing, flooring, walls, cabinets (kitchen and bath) and fixtures, such as faucets and shower head, are discussed below.

Walls, Doors and Cabinets and Fixtures

Bathroom

Doors

Third Party Notices