Skip to content

Latest commit

 

History

History
86 lines (51 loc) · 2.21 KB

Build.md

File metadata and controls

86 lines (51 loc) · 2.21 KB
Raw

Building

How to build this project locally

Generating

Requirements:

See also requirements.txt.

The Python packages are installed into a virtual environment like this:

python3 -m venv .venv                       # create a virtual environment
source .venv/bin/activate                   # activate it
python3 -m pip install -r requirements.txt  # install the required packages

To generate the  html  files, simply execute  generate.py

This will build the different pages from the repos reference material with the help of shell and python scripts.

./generate --wip builds everything including colors and c64io.

./generate.py --only 6502 colors c64mem only builds the selected categories (using the category path names as keys).

The 6502 and the color reference are all Java Script and do not need to be generated while developing, but for release the umbrella generate.py adds navigation, matching titles and a link to the github project.

Testing

For testing start Python's built-in webserver and navigate to the local url:

python3 -m http.server

http://localhost:8000/c64ref/6502/

If the default port is already taken, choose your own port (eg. 6464):

python3 -m http.server 6464

http://localhost:6464/c64ref/6502/

Navigate using the menu bar or by directly going to the specific pages:

  • 6502 for 6502 Family CPU Reference
  • c64disasm for C64 BASIC & KERNAL ROM Disassembly (Slow)
  • c64io for C64 I/O Map (WIP)
  • c64mem for C64 Memory Map
  • charset for Character Set · PETSCII · Keyboard
  • colors for C64 Colors (WIP)
  • kernal for C64 KERNAL API

Upload

For uploading use

./generate upload

It checks for changes in the working copy and won't let you build if there are any.