Update readme to reflect KiCad 6 and new parts (closes #6)

This commit is contained in:
Nicholas Parks Young 2022-10-29 20:35:20 +01:00
parent 75a49dd0ef
commit dce972e21d

View File

@ -1,7 +1,7 @@
# 6502 KiCad Library # 6502 KiCad Library
*Version 1.0.0* *Version 2.0.0*
Library of schematic components of a variety of Commodore, MOS Technologies and Wester Design Center chips for KiCad. Library of schematic components of a variety of Commodore, MOS Technologies and Wester Design Center chips for KiCad 6.
Currently included are: Currently included are:
- 6502 8-bit NMOS Microprocessor, 64K, DIP-40 - 6502 8-bit NMOS Microprocessor, 64K, DIP-40
@ -35,27 +35,32 @@ Currently included are:
- 8500 8-bit HMOS Microprocessor, 64K, 6-bit I/O Port, DIP-40 - 8500 8-bit HMOS Microprocessor, 64K, 6-bit I/O Port, DIP-40
- 8502 8-bit HMOS Microprocessor, 64K, 7-bit I/O Port, DIP-40 - 8502 8-bit HMOS Microprocessor, 64K, 7-bit I/O Port, DIP-40
- 8580 HMOS Sound Interface Device (SID), 3-Voice Sound Synthesizer, DIP-28 - 8580 HMOS Sound Interface Device (SID), 3-Voice Sound Synthesizer, DIP-28
- W65C02S 8-bit CMOS General Purpose Microprocessor, DIP-40 - W65C02S_P 8-bit CMOS General Purpose Microprocessor, DIP-40
- W65C02S 8-bit CMOS General Purpose Microprocessor, PLCC-44 - W65C02S_PL 8-bit CMOS General Purpose Microprocessor, PLCC-44
- W65C02S 8-bit CMOS General Purpose Microprocessor, PQFP-44 - W65C02S_Q 8-bit CMOS General Purpose Microprocessor, LQFP-44
- W65C21N CMOS Peripheral Interface Adapter (PIA), 20-pin I/O, NMOS-Compatible, DIP-40 - W65C21N_P CMOS Peripheral Interface Adapter (PIA), 20-pin I/O, NMOS-Compatible, DIP-40
- W65C21N CMOS Peripheral Interface Adapter (PIA), 20-pin I/O, NMOS-Compatible, PLCC-44 - W65C21N_PL CMOS Peripheral Interface Adapter (PIA), 20-pin I/O, NMOS-Compatible, PLCC-44
- W65C21S CMOS Peripheral Interface Adapter (PIA), 20-pin I/O, DIP-40 - W65C21S_P CMOS Peripheral Interface Adapter (PIA), 20-pin I/O, DIP-40
- W65C21S CMOS Peripheral Interface Adapter (PIA), 20-pin I/O, PLCC-44 - W65C21S_PL CMOS Peripheral Interface Adapter (PIA), 20-pin I/O, PLCC-44
- W65C22N CMOS Versatile Interface Adapter (VIA), 20-pin I/O, 2 Timer/Counters, NMOS-Compatible, DIP-40 - W65C22N_P CMOS Versatile Interface Adapter (VIA), 20-pin I/O, 2 Timer/Counters, NMOS-Compatible, DIP-40
- W65C22S CMOS Versatile Interface Adapter (VIA), 20-pin I/O, 2 Timer/Counters, PLCC-44 - W65C22N_PL CMOS Versatile Interface Adapter (VIA), 20-pin I/O, 2 Timer/Counters, NMOS-Compatible, PLCC-44
- W65C22S CMOS Versatile Interface Adapter (VIA), 20-pin I/O, 2 Timer/Counters, PQFP-44 - W65C22S_P CMOS Versatile Interface Adapter (VIA), 20-pin I/O, 2 Timer/Counters, DIP-40
- W65C51N CMOS Asynchronous Communication Interface Adapter (ACIA), Serial UART, DIP-28 - W65C22S_PL CMOS Versatile Interface Adapter (VIA), 20-pin I/O, 2 Timer/Counters, PLCC-44
- W65C51N CMOS Asynchronous Communication Interface Adapter (ACIA), Serial UART, PLCC-28 - W65C22S_Q CMOS Versatile Interface Adapter (VIA), 20-pin I/O, 2 Timer/Counters, LQFP-44
- W65C51N CMOS Asynchronous Communication Interface Adapter (ACIA), Serial UART, PQFP-32 - W65C51N_P CMOS Asynchronous Communication Interface Adapter (ACIA), Serial UART, DIP-28
- W65C816S 8/16-bit CMOS General Purpose Microprocessor, DIP-40 - W65C51N_PL CMOS Asynchronous Communication Interface Adapter (ACIA), Serial UART, PLCC-28
- W65C816S 8/16-bit CMOS General Purpose Microprocessor, PLCC-44 - W65C51N_Q CMOS Asynchronous Communication Interface Adapter (ACIA), Serial UART, LQFP-32
- W65C02S 8/16-bit CMOS General Purpose Microprocessor, PQFP-44 - W65C134S_PL 8-bit CMOS Microcontroller, PLCC-68
- W65C134S_Q 8-bit CMOS Microcontroller, LQFP-80
- W65C265S_PL 8/16-bit CMOS Microcontroller, PLCC-84
- W65C265S_Q 8/16-bit CMOS Microcontroller, QFP-100
- W65C816S_P 8/16-bit CMOS General Purpose Microprocessor, DIP-40
- W65C816S_PL 8/16-bit CMOS General Purpose Microprocessor, PLCC-44
- W65C816S_Q 8/16-bit CMOS General Purpose Microprocessor, LQFP-44
Planned for future inclusion: Planned for future inclusion:
- The VIC, VIC-II and VIC-IIe - The VIC, VIC-II and VIC-IIe
- The TED - The TED
- The WDC 6502-derived Microcontrollers
## Schematic Compatibility Between Similar Components ## Schematic Compatibility Between Similar Components
@ -63,12 +68,16 @@ The schematic components in this library have been specifically laid out such th
For example, if you were creating a design with the 6502 part, but then decided to replace it with a 6512 part, the phase 0 and phase 2 pins are in the same location because they have compatible functionality, but the phase 1 pins are not because on the 6512 it is an input, whilst on the 6502 it is an output. For example, if you were creating a design with the 6502 part, but then decided to replace it with a 6512 part, the phase 0 and phase 2 pins are in the same location because they have compatible functionality, but the phase 1 pins are not because on the 6512 it is an input, whilst on the 6502 it is an output.
## Compatibility with KiCad 5
This library is in the new KiCad 6 "S-Expressions" format, and is not compatible with KiCad 5. If you need compatibility with KiCad 5, please use version 1.0.0 of this repository - but be aware that said version does not contain all features and is not being maintained.
## Comments, Requests, Bugs & Contributions ## Comments, Requests, Bugs & Contributions
All are welcome. All are welcome.
Please file an Issue or Pull Request at https://github.com/Alarm-Siren/6502-Kicad-library Please file an Issue or Pull Request at https://github.com/Alarm-Siren/6502-Kicad-library
## License ## License
Copyright 2018, Nicholas Parks Young. All Rights Reserved. Copyright 2018-2022, Nicholas Parks Young. All Rights Reserved.
This library is licensed under the GNU LGPL v2.1, which can be found in file LICENSE.txt. This library is licensed under the GNU LGPL v2.1, which can be found in file LICENSE.txt.
## Donations ## Donations
@ -79,10 +88,10 @@ If you've found this library useful and you'd like to make a donation towards it
## Library Setup ## Library Setup
To add this library to your KiCad Project, do the following steps: To add this library to your KiCad Project, do the following steps:
1. Copy the source files "65xx.lib" and "65xx.dcm" to the root of your KiCad project's folder. 1. Copy the source files "65xx.kicad_sym" to the root of your KiCad project's folder.
2. In Eeschema (the schematic editor of KiCad) go to the "Preferences" -> "Manage Symbol Libraries..." menu option. 2. In Schematic Editor go to the "Preferences" -> "Manage Symbol Libraries..." menu option.
3. In the Symbol Libraries dialogue that appears, switch to the "Project Specific Libraries" tab. 3. In the Symbol Libraries dialogue that appears, switch to the "Project Specific Libraries" tab.
4. Click "Append Library", beneath the table. 4. Click "Add empty row to table" button (the button with a big cross in it, beneath the table).
5. In the new line of the table, set Library Path to "$(KIPRJMOD)\65xx.lib" on Windows or "$(KIPRJMOD)/65xx.lib" on Linux/Mac, and ensure Plugin Type is "Legacy". 5. In the new line of the table, set Library Path to "${KIPRJMOD}\65xx.kicad_sym" on Windows or "${KIPRJMOD}/65xx.kicad_sym" on Linux/Mac, and ensure Plugin Type is "KiCad".
6. You can leave the Options and Description fields blank. You should set Nickname to something descriptive - for example, "65xx library". 6. You can leave the Options and Description fields blank. You should set Nickname to something descriptive - for example, "65xx library".
7. All done: you are now ready to use these schematic components in your project! 7. All done: you are now ready to use these schematic components in your project!