Skip to content

Commit

Permalink
Updated docs to add the new programmer
Browse files Browse the repository at this point in the history
  • Loading branch information
Rex-- committed Jan 28, 2024
1 parent 023c9ab commit 47b44ce
Show file tree
Hide file tree
Showing 6 changed files with 40 additions and 22 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
University of Illinois/NCSA Open Source License

Copyright (c) 2022, Rex McKinnon. All rights reserved.
Copyright (c) 2022-2024, Rex McKinnon. All rights reserved.

Developed by:

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,6 @@ actions:
## Copying
Copyright (C) 2022 Rex McKinnon \
Copyright (C) 2022-2024 Rex McKinnon \
This software is released under the University of Illinois/NCSA
Open Source License. Check the LICENSE file for more details.
13 changes: 8 additions & 5 deletions docs/picchick.1
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
'\" t
.\" Title: picchick
.\" Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.17
.\" Date: 2022-10-29
.\" Generator: Asciidoctor 2.0.20
.\" Date: 2024-01-27
.\" Manual: Picchick Manual
.\" Source: picchick v0.4.0
.\" Source: picchick v0.4.1
.\" Language: English
.\"
.TH "PICCHICK" "1" "2022-10-29" "picchick v0.4.0" "Picchick Manual"
.TH "PICCHICK" "1" "2024-01-27" "picchick v0.4.1" "Picchick Manual"
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.ss \n[.ss] 0
Expand Down Expand Up @@ -119,6 +119,9 @@ interface.
.SS "flipflop"
.sp
flipflop is a bootloader that runs on PIC16F1 devices with an EUSART.
.SS "arduino\-icsp"
.sp
Arduino powered low\-voltage ICSP programmer for PICs.
.SH "RESOURCES"
.sp
\fBGithub:\fP \c
Expand All @@ -128,7 +131,7 @@ flipflop is a bootloader that runs on PIC16F1 devices with an EUSART.
.URL "https://rex.mckinnon.ninja/picchick" "" ""
.SH "COPYING"
.sp
Copyright \(co 2022 Rex McKinnon
Copyright \(co 2022\-2024 Rex McKinnon
.br
This software is released under the University of Illinois/NCSA
Open Source License. Check the LICENSE file for more details.
28 changes: 16 additions & 12 deletions docs/picchick.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 2.0.17">
<meta name="generator" content="Asciidoctor 2.0.20">
<title>picchick documentation</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
<style>
Expand Down Expand Up @@ -84,10 +84,10 @@
ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
ul,ol{margin-left:1.5em}
ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
ul.square{list-style-type:square}
ul.circle{list-style-type:circle}
ul.disc{list-style-type:disc}
ul.square{list-style-type:square}
ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
dl dt{margin-bottom:.3125em;font-weight:bold}
dl dd{margin-bottom:1.25em}
Expand Down Expand Up @@ -208,13 +208,10 @@
.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
.exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
.exampleblock>.content>:first-child{margin-top:0}
.exampleblock>.content>:last-child{margin-bottom:0}
.sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
.sidebarblock>:first-child{margin-top:0}
.sidebarblock>:last-child{margin-bottom:0}
.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
.exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
.exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
.literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
@media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
@media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
Expand Down Expand Up @@ -393,7 +390,7 @@
dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
p,blockquote,dt,td.content,span.alt,summary{font-size:1.0625rem}
p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
p{margin-bottom:1.25rem}
.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
.exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
Expand Down Expand Up @@ -705,6 +702,13 @@ <h3 id="_programmers">Programmers</h3>
device&#8217;s own memory.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://github.com/Rex--/flipflop">Github</a></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>arduino-icsp</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">PIC</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Arduino sketch that implements a programmer for PIC devices that use the low
voltage In Circuit Serial Programming protocol.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://github.com/Rex--/arduino-icsp">Github</a></p></td>
</tr>
</tbody>
</table>
</div>
Expand Down Expand Up @@ -1028,22 +1032,22 @@ <h3 id="_actions">Actions</h3>
<hr>
<div class="paragraph text-center">
<p><span class="big"><a href="https://github.com/Rex--/picchick">github</a> | <a href="https://rex.mckinnon.ninja/picchick">documentation</a></span><br>
&copy; 2022 Rex McKinnon</p>
&copy; 2022-2024 Rex McKinnon</p>
</div>
</div>
</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2022-10-29 15:51:05 -0700
Last updated 2024-01-27 20:20:29 -0800
</div>
</div>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>
<script>
if (!hljs.initHighlighting.called) {
hljs.initHighlighting.called = true
;[].slice.call(document.querySelectorAll('pre.highlight > code')).forEach(function (el) { hljs.highlightBlock(el) })
;[].slice.call(document.querySelectorAll('pre.highlight > code[data-lang]')).forEach(function (el) { hljs.highlightBlock(el) })
}
</script>
</body>
Expand Down
7 changes: 5 additions & 2 deletions docs/src/picchick-man.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= picchick(1)
:doctype: manpage
:manmanual: Picchick Manual
:mansource: picchick v0.4.0
:mansource: picchick v0.4.1
:link-picchick-github: https://github.com/Rex--/picchick
:link-picchick-docs: https://rex.mckinnon.ninja/picchick

Expand Down Expand Up @@ -71,14 +71,17 @@ interface.
=== flipflop
flipflop is a bootloader that runs on PIC16F1 devices with an EUSART.

=== arduino-icsp
Arduino powered low-voltage ICSP programmer for PICs.

== Resources

*Github:* {link-picchick-github}

*Documentation:* {link-picchick-docs}

== Copying
Copyright (C) 2022 Rex McKinnon +
Copyright (C) 2022-2024 Rex McKinnon +
This software is released under the University of Illinois/NCSA
Open Source License. Check the LICENSE file for more details.
endif::[]
10 changes: 9 additions & 1 deletion docs/src/picchick.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
:link-picchick-github: https://github.com/Rex--/picchick
:link-picstick: https://github.com/Rex--/picstick
:link-flipflop: https://github.com/Rex--/flipflop
:link-arduino-icsp: https://github.com/Rex--/arduino-icsp

`picchick` is a command-line utility used for programming and debugging
microcontrollers.
Expand Down Expand Up @@ -167,6 +168,13 @@ interface.
|Flipflop runs as the bootloader on some PIC micros, reading and writing the
device's own memory.
|{link-flipflop}[Github]

|`arduino-icsp`
|PIC
|Arduino sketch that implements a programmer for PIC devices that use the low
voltage In Circuit Serial Programming protocol.
|{link-arduino-icsp}[Github]

|===


Expand Down Expand Up @@ -340,4 +348,4 @@ include::picchick-man.adoc[leveloffset=+1]
---
[.text-center]
[.big]#{link-picchick-github}[github] | {link-picchick-docs}[documentation]# +
&copy; 2022 Rex McKinnon
&copy; 2022-2024 Rex McKinnon

0 comments on commit 47b44ce

Please sign in to comment.