+  RHDN Forum Archive
|-+  Romhacking
| |-+  ROM Hacking Discussion
| | |-+  Help writing a readme file.
Pages: [1]
Author Topic: Help writing a readme file.  (Read 1 times)
Mauron
Guest
« on: July 13, 2011, 08:42:53 am »
I wasn't sure where best to stick this. I've completed a few Temporal Flux plugins, and will be releasing them once I have a readme for them written.

Quote
1) Requirements
Temporal Flux 3.01, and the .Net Framework 2.0.
2) Installation
Copy MonsterPlugin.dll to the Temporal Flux directory.
3) Uninstallation
Delete MonsterPlugin.dll
4) Usage
Open any of the three SNES ROM versions (US, Japanese, or Pre-Release) in Temporal Flux, and choose Monster Editor from the Plugins menu.
5) Contact
For any questions or theories about unknown bytes, message Mauron on Romhacking.net or email mauron@maurtopia.com with Temporal Flux somewhere in the subject line.
6) Thanks
Geiger, for Temporal Flux, and the numerous people whose research over the years made this program possible.

This is for one of them. Any suggestions would be helpful.
Malias
Guest
« Reply #1 on: July 13, 2011, 04:37:51 pm »
It might be nice to put a short description of what the plugins do at the beginning. You could also include some general operation instructions if it isn't totally obvious.  Otherwise, it looks good.
Ryusui
Guest
« Reply #2 on: July 13, 2011, 05:32:12 pm »
The directions seem a bit sparse, but yeah, the biggest problem is that you don't provide any specific instructions on how to use them.
Mauron
Guest
« Reply #3 on: July 14, 2011, 07:36:09 am »
Quote from: Ryusui on July 13, 2011, 05:32:12 pm
The directions seem a bit sparse, but yeah, the biggest problem is that you don't provide any specific instructions on how to use them.

Oh, whoops. I'll add some specifics. As for them being sparse, I couldn't really think of more to add in most cases.
Klarth
Guest
« Reply #4 on: July 14, 2011, 09:02:38 am »
Specifics like bugs/limitations/features.  The biggest ones would probably be whether this plugin edits all original CT monsters...any custom added monsters (or supports adding monsters...)...and whether the monster data has to be in the original location or not.
Shinrin
Guest
« Reply #5 on: July 15, 2011, 12:24:51 am »
I've also seen change logs in a readme file for hacks, translations and utilities, heck, even some game FAQ's have these.
Pages: [1]  


Powered by SMF 1.1.4 | SMF © 2006-2007, Simple Machines LLC