Skip to content

jfishe/Richland_prefab_2br

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

title subtitle author email
README
Richland Prefab 2BR
John D. Fisher

Description

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.

Installation

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

Build PDF and HTML5

The Makefile builds printable PDF's and local 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 pdf defaults to KOMA-Script scrartcl, specified in Richland_Prefab_2BR.mdpp YAML meta-data.

The Makefile expects a symbolic link in the local directory to a Dropbox folder for remodel_richland.droppages.com. Update 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 droppages.com.

Droppages.com Setup

Droppages.com provides instructions for setting up Dropbox/Apps/My.DropPages/remodel_richland.droppages.com

To be compatible with Windows 10, generate the symbolic link with something similar to the Windows cmd.exe step below. Start in the directory from which you cloned this repository.

mklink /D remodel_richland.droppages.com ^
  %USERPROFILE%\Dropbox\Apps\My.DropPages\remodel_richland.droppages.com

Track Changes with PDF Comments

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 ommitted, 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.

Anaconda or Miniconda

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; they may or may not work in Python 2.7.

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

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

Overview

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

Electrical Phase 1

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

Electrical Upgrade

Walls, Doors and Cabinets and Fixtures Phase 1

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 Phase 2

Bathroom

Doors Phase 2

Doors

Third Party Notices

Third Party Notices