Skip to content

Instantly share code, notes, and snippets.

@angieherrera

angieherrera/website-readme.md

Last active January 13, 2021 17:02
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save angieherrera/5e5f34673c88d59d341427207e8f879f to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save angieherrera/5e5f34673c88d59d341427207e8f879f to your computer and use it in GitHub Desktop.
Download ZIP
Raw
website-readme.md

Project README

Requirements

The required bits and bobs of the project (e.g. CMS, Tailwind, etc.)

Project Notes

Pertinent high-level information about the project

Setup

Steps for setting things up, particularly if for a CMS

Front-end Compiling

Steps for front-end compiling

Files & directories

List of key files and directories, how they're organized and used, etc.

Hacks/Kludges

  1. Hack/kludge name Short description of what was done and why, including any reference links

    • When: date

    • File(s):

      • Line #N in [path to file]
      • Line #N in [path to file]

    • Database: Note any changes to the database. If none, delete this line.

Design Notes

If needed, pertinent design notes

Credits

Kinda obvious, no? ;)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment