README - griffingilreath/Punch-Card-Project GitHub Wiki

Punch Card Project Wiki Content

This directory contains the Markdown files that make up the GitHub Wiki for the Punch Card Project. These files are designed to be pushed to the repository's wiki.

Structure

  • Home.md - The main landing page of the wiki
  • _Sidebar.md - The sidebar navigation that appears on all wiki pages
  • Other .md files - Individual wiki pages for various topics

How to Use

  1. Enable the Wiki in your GitHub repository settings
  2. Clone the wiki repository: git clone [email protected]:griffingilreath/Punch-Card-Project.wiki.git
  3. Copy these files to the wiki repository
  4. Commit and push the changes

Alternatively, run the setup_github_wiki.sh script which automates this process.

Pages Overview

User Guides

  • Installation-Guide.md - How to install and set up the project
  • Usage-Guide.md - Basic usage instructions and examples
  • Configuration.md - Configuration options and customization
  • Command-Line-Arguments.md - Available command line options

Design Research

  • Interface-Design-History.md - The evolution of computer interfaces
  • Early-Apple-UI-Design.md - Apple's influence on interface design
  • Punch-Card-Encoding.md - Technical details on punch card character encoding
  • LED-Implementation.md - Guide to LED matrix implementation
  • Sociological-Aspects.md - The cultural impact of punch cards

Development

  • Project-Structure.md - Overview of the codebase organization
  • Contributing-Guidelines.md - How to contribute to the project
  • Version-History.md - Detailed changelog of all versions

Adding New Pages

  1. Create a new Markdown file with the page name (use hyphens instead of spaces)
  2. Add a link to the page in _Sidebar.md for navigation
  3. Add links to the page from related pages where appropriate

Formatting Guidelines

  • Use Markdown formatting for all content
  • Include a clear title at the top of each page using a single # header
  • Organize content with ## and ### subheadings
  • Use code blocks with syntax highlighting when showing code
  • Include a "Last updated" date at the bottom of each page

Images and Media

Store images in the repository's wiki/images/ directory and reference them in Markdown:

![Image Description](images/example.png)