Giter VIP home page Giter VIP logo

mega65-user-guide's Introduction

MEGA65 User Guide

This is community effort to create a User Guide for the MEGA65 in the spirit of the original User Guide for the Commodore 64.

Just show me the PDFs!

If you just want the typeset manuals, hop over to the releases page at:

https://github.com/MEGA65/mega65-user-guide/releases

Installation

Requirements

Usage

The User Guide project is defined using a Makefile to build. Therefore if you are using an environment like TeXworks, do not use the built in Build button. That is for single file building only. For MingW32 users, just use:

mingw32-make or mingw32-make mega65-userguide.pdf in the main folder of the project to build the mega65-userguide.pdf file.

For linux: make or make mega65-userguide.pdf.

If you wish to build the reference manual, use: mingw32-make referenceguide.pdf.

If you wish to build the nexys4 setup guide, use: mingw32-make nexys4-setup-guide.pdf.

To build the entire book, use: mingw32-make mega65-book.pdf.

There is also a sandbox.pdf for experimenting with typesetting or components for the manuals. But it is not included in the makefile. Instead, it is able to be built directly using software like TeXworks.

The sandbox is faster to build and test changes more quickly. You can then transfer your work directly to the userguide.

The complete list of guides that can be individually built are:

Book Build
User Guide make mega65-userguide.pdf
Chipset Reference make mega65-chipset-reference.pdf
Complete BASIC 10 Commands make mega65-basic10-reference.pdf
For experimentation (don't commit) make sandbox.pdf
Reference Guide make referenceguide.pdf
Developer's Guide make mega65-developer-guide.pdf
Guide to MEGA65 and FPGA Hardware make hardwareguide.pdf
All books combined make mega65-book.pdf
As above but in CYMK for printing (Ghostscript required) make mega65-book-cmyk.pdf:

MAC OSX

It is recommended to install MacPorts, which gives easy access to a huge base of Linux/UNIX software. With MacPorts install following LaTeX packages:

sudo port install texlive-latex

sudo port install texlive-latex-extra

sudo port install texlive-latex-recommended

sudo port install latexmk

sudo port install latexdiff

Then creating the complete MEGA65 documentation is done in the local repository work directory with:

make clean

make mega65-book.pdf

make mega65-book.pdf

Calling "make" with the target twice is intentional and needed for getting all references resolved. Of course, you can create a shell script for these three lines.

Linux

For Linux users, the instructions are the similar, but use your favourite package manager to install a LaTeX package of your choice.

Editors

Visual Studio Code

Combined with the LaTeX Workshop extension, this is a great IDE for working with the project. However be careful of the using the built-in terminal for compiling the guides. It's a powershell-based terminal and won't work with the Makefile. Nor will Command Prompt. Use a more Unix styled terminal like Git Bash.

mega65-user-guide's People

Contributors

edilbert avatar gardners avatar sausagejohnson avatar woepaul avatar steph72 avatar deftmega avatar mauricemega65 avatar isedwards avatar mlund avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.