Skip to content

Dn-Programming-Core-Management/Dn-help

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

67 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Dn-Famitracker Help

This repository hosts the source code for Dn-Famitracker's help dialog. While the main program indeed has this contained within it's own source code, the main use of this repository is to provide finalized and finished versions of the Help File to all new releases of Dn-FamiTracker.

As such it is best to consider this repository a "development" build of the help file, and may not represent the "final" builds included with Dn-FamiTracker releases.

Goals

These goals are for what should be finished in the Help File for the next full Dn-FamiTracker release:

  • Complete Sunsoft 5B documentation (almost done)
  • Add Command Line argument documentation
  • Clean up/correct documentation for other sound chips (2A03, MMC5, etc.)
  • Update the FAQ to include newer Dn-Famitracker features
  • Update some screenshots and images to better reflect Dn-Famitracker's interface.
  • Add "versions" to the Help file, to keep track of revisions made to the project files. (This will be done for the next Dn-FamiTracker release.)

Future roadmap

  • Recode the entire help file from scratch
    • Will likely be done when the current help file is considered "complete".
    • Alternatively, recode what exists to help make future additions easier to implement.
  • Host "release" versions on a website of some kind for viewing in a browser, much like the archived CheeseCutter manual.
    • This will likely be done when the manual is considered "complete".
  • Possibly include (technical) documentations on FamiTracker's module and instrument formats, and also possibly the export formats.

Contributing

All contributions are welcome, feel free to submit pull requests, or submit suggestions/code bugs/improvements in the issue tracker. Alternatively, contact a Dn-FamiTracker contributor in the Famitracker.org Discord Server.

License

Since this is a fragment of Dn-Famitracker's codebase, the license falls under the same terms.