zjkuki/TommyPROM
1
0
Fork 0
forked from Apple-2-HW/TommyPROM
Code Issues Pull Requests Packages Projects Releases Wiki Activity

broken links and footer

Browse Source
This commit is contained in:
Tom Nisbet 2020-06-29 14:54:01 -04:00
parent fe8ecfe92e
commit 59db23ba92
3 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/_config.yml
View File

@ -67,14 +67,14 @@ nav_sort: case_insensitive # default, equivalent to nil
back_to_top: true back_to_top: true
back_to_top_text: "Back to top" back_to_top_text: "Back to top"
#footer_content: "Copyright &copy; 2017-2020 Patrick Marsceill. Distributed by an <a href=\"https://github.com/pmarsceill/just-the-docs/tree/master/LICENSE.txt\">MIT license.</a>" footer_content: "<a href=\"https://github.com/TomNisbet/TommyPROM">Return to GitHub project</a>"
# Footer last edited timestamp # Footer last edited timestamp
#last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter #last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
#last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html #last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html
# Footer "Edit this page on GitHub" link text # Footer "Edit this page on GitHub" link text
gh_edit_link: true # show or hide edit this page link gh_edit_link: false # show or hide edit this page link
gh_edit_link_text: "Return to GitHub project" gh_edit_link_text: "Return to GitHub project"
gh_edit_repository: "https://github.com/tomnisbet/TommyPROM" gh_edit_repository: "https://github.com/tomnisbet/TommyPROM"
gh_edit_branch: "master" # the branch that your docs is served from gh_edit_branch: "master" # the branch that your docs is served from

8
docs/index.md
View File

@ -19,7 +19,7 @@ The original code was specific to the 28C256 32Kx8 EEPROM, but it has been exten
The 28C design can be used with other 5V EEPROMS as well. Many 5V chips, including UV The 28C design can be used with other 5V EEPROMS as well. Many 5V chips, including UV
EPROMs, such as the 2716, 2764, 27C2001 and 27C040, can be read, but not written, with the EPROMs, such as the 2716, 2764, 27C2001 and 27C040, can be read, but not written, with the
basic hardware. Some pin changes may be needed to get the signals to the correct pins on basic hardware. Some pin changes may be needed to get the signals to the correct pins on
the device. See the [Extending the design](extending.html) page for details on suggested the device. See the [Extending the design](extending) page for details on suggested
hardware and software changes needed to support new EPROM and EEPROM families. hardware and software changes needed to support new EPROM and EEPROM families.
The PROM-specific code is modular and can be easily adapted to support additional devices. The PROM-specific code is modular and can be easily adapted to support additional devices.
@ -40,7 +40,7 @@ Features include:
* Optimized code that supports the timing requirements needed to unlock the 28C series Software Protection Algorithm. * Optimized code that supports the timing requirements needed to unlock the 28C series Software Protection Algorithm.
* Modular software design to easily support other EEPROM and EPROM families. * Modular software design to easily support other EEPROM and EPROM families.
The [hardware](hardware.html) page has descriptions of the hardware designs and links to schematics. The [software](software.html) page has class definitions and more information The [hardware](hardware) page has descriptions of the hardware designs and links to schematics. The [software](software) page has class definitions and more information
on the software design. on the software design.
The project was inspired by the The project was inspired by the
@ -105,11 +105,11 @@ have different port mappings and definitely will not work without software chang
verify that the data and address paths are good. verify that the data and address paths are good.
* 28C series EEPROMS, like the X28C256, sometimes ship from the factory with Data * 28C series EEPROMS, like the X28C256, sometimes ship from the factory with Data
Protection enabled. Use the UNLOCK command to disable this. See the Protection enabled. Use the UNLOCK command to disable this. See the
[28C256 Notes](28C256-notes.html) for more information. [28C256 Notes](28C256-notes) for more information.
* Re-check all hardware connections and verify the the control pins are going to the * Re-check all hardware connections and verify the the control pins are going to the
Arduino pins that match the definitions in the code. Arduino pins that match the definitions in the code.
* This repo contains a standalone program called HardwareVerify that allows low-level * This repo contains a standalone program called HardwareVerify that allows low-level
access to the address, data, and control lines through a menu-driven interface. See the [troubleshooting](troubleshooting.html) section for more tips. access to the address, data, and control lines through a menu-driven interface. See the [troubleshooting](troubleshooting) section for more tips.
## Further Work ## Further Work
* [ ]Add a new PromDevice class for 27 series EPROMS. * [ ]Add a new PromDevice class for 27 series EPROMS.

2
docs/software.md
View File

@ -9,7 +9,7 @@ nav_order: 3
The software is designed around several major blocks and classes. The code has been The software is designed around several major blocks and classes. The code has been
broken out into individual files to make it easy to extend the hardware support to broken out into individual files to make it easy to extend the hardware support to
additional EPROM and EEPROM families. See the additional EPROM and EEPROM families. See the
[Adding Chip Families](extending.html) page for details on suggested hardware and software [Adding Chip Families](extending) page for details on suggested hardware and software
changes needed. changes needed.
## CommandStatus class ## CommandStatus class