Skip to content

Commit 9f1113c

Browse files
authored
Add README
1 parent bd2a920 commit 9f1113c

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Dn-Famitracker Help
2+
3+
This repository hosts the source code for [Dn-Famitracker](https://github.com/Gumball2415/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.
4+
5+
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.
6+
7+
## Goals
8+
9+
These goals are for what should be finished in the Help File for the next full Dn-FamiTracker release:
10+
11+
- [ ] Complete Sunsoft 5B documentation (almost done)
12+
- [ ] Add Command Line argument documentation
13+
- [ ] Clean up/correct documentation for other sound chips (2A03, MMC5, etc.)
14+
- [ ] Update the FAQ to include newer Dn-Famitracker features
15+
- [ ] Update some screenshots and images to better reflect Dn-Famitracker's interface.
16+
- [ ] 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.)
17+
18+
#### Future roadmap
19+
20+
- Recode the entire help file from scratch
21+
- Will likely be done when the current help file is considered "complete".
22+
- Alternatively, recode what exists to help make future additions easier to implement.
23+
- Host "release" versions on a website of some kind for viewing in a browser, much like the [archived CheeseCutter manual.](https://carol6502.neocities.org/c6_ccutter_guide.html)
24+
- This will likely be done when the manual is considered "complete".
25+
- Possibly include (technical) documentations on FamiTracker's module and instrument formats, and also possibly the export formats.
26+
27+
## Contributing
28+
29+
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.

0 commit comments

Comments
 (0)