Readme !!
There's more information down below, but as this is now a resource on the lexaloffle website, I thought I'd add some extras.
This cartridge is just a viewer for the Github Wiki, run by myself and impossible without the community that's supported me; it wouldn't be here without you all.
There is another viewer, Inuwiki, another picotron cartridge; this one made by @HowfWuff, as of writing this with less features (like auto-updating), but a windowed and very clean UI!
You may find a better viewing experience through the web wiki viewer or the Github repository itself
In the future, I'll be updating this cartridge & the web version to be much, much better.
List of front ends:
- (this cart)
- Github Repository
- Wiki Web Viewer
- Inuwiki
Picotron Wiki Cartridge
Information
This is a cartridge making use of the pod form of the wiki's database.
There are some known issues as listed below
Download
This can be found on the Lexaloffle BBS
or downloaded with:
load #wiki -u save /where/to/store/the/wiki/cart.p64 |
Credits
Development - Astralsparv
Lilwide font - thelxinoe5
Word Wrapping algorithm - abledbody
Bug Testing - lumpycamel123
Features!
Go through the entire wiki through the database.
Includes basic markdown support
Allows you to copy paste code snippets from codeblocks
Codeblocks are auto-syntaxed
Clickable hyperlinks
Ability to open hyperlinks & pages in the host os by middle clicking (or CTRL clicking) them!
Touchscreen/drag-based scrolling
One click easy updating
Custom themes (colors in hex and fonts)
Generates entries for missing functions (based on the loaded Picotron API)
Right click on the sidebar to open the source code & other information about functions
Rudimentary search for the wiki with the top left search bar
To Do / Issues
Some markdown formatting isn't correct (I think this comes from the pod db treating the md codeblock headers as real headers, seen in documenting.md)
link.md/#header doesn't work
There's no variation between headers, they are all lilwide.
No scrollbar & no max scroll
Massive updates made
This is now fully* viable as a wiki viewer (simply lacks table formatting and images)
I would like to bump this and make the request for:
- celebration!!
50% of the Picotron API is documented (kernel included).
API Functions: 114/168 (67.85%)
Kernel Functions: 13/84 (15.47%)
All Functions: 127/252 (50.39%)
- join us!
I'm going to be a lot more busy with my exams and my own fantasy console, and I'd love for anyone else to be able to chip in if they've free to! Picotron is so great how it is thanks to the community, and the more we make it more information rich, the more we open that community to others.
Thank you all who have contributed and supported the journey, and thank you to those who help us in the future!
Thank you for working to make something like this available to everyone! Picotron can be confusing, and it's awesome to have someone working on something like this. Kudos to you!
I'm guessing this is pulling from https://github.com/Astralsparv/Picotron-Wiki. If someone wanted to contribute to this, would they open a pull request to there?
Thank you, there's been a few people helping out already, and the people making video guides for people - I don't want to take all the credit!
Yeah it is; there should be a markdown file going over how to document for it
Edit: said documenting file
Thank you! I had actually been trying to contribute to the other wiki, but that doesn't look that realistic now, to be honest. I'd like to try to help out with this at some point!
Much appreciated! No other wikis are being actively maintained and I've made quite a few efforts to make this long-lasting (being able to be moved to someone else's repo easily in case I just poof, multiple db formats so that you can use it in different projects [json, pod, md]).
Zep also said that they'd put it as a resource on the website after Pi Day, but I think they may have gotten sidetracked.
The Web Wiki is now released; originally just a search engine and now fully functional as a web wiki viewer.
will be working on the picotron wiki webversion & source system
if anyone has ideas for how they'd want the wiki to look on the web, feel free to share!
i'm wanting to make it look alot nicer
the wiki will also be likely moving it's source to https://git.astralsparv.cc/astralsparv/Picotron-Wiki (and then a backup repository on another git service to act as a backup/mirror).
https://pt_wiki.astralsparv.cc/ or https://picotron_wiki.astralsparv.cc/ (both lead to same thing) are now web viewers for this!
the old web viewer will be abandoned evnetually & the github repo, but atm this cart still uses it
think i might re-code this though to avoid pre-processing
[Please log in to post a comment]
