News: 11 March 2016 - Forum Rules
Current Moderators - DarkSol, KingMike, MathOnNapkins, Azkadellia, Danke

Author Topic: Help writing a readme file.  (Read 2383 times)

Mauron

  • Sr. Member
  • ****
  • Posts: 472
    • View Profile
Help writing a readme file.
« on: July 13, 2011, 09: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.
Mauron wuz here.

Malias

  • Sr. Member
  • ****
  • Posts: 290
    • View Profile
Re: Help writing a readme file.
« Reply #1 on: July 13, 2011, 05: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.
The great achievement is to lose one's reason for no reason, and to let my lady know that if I can do this without cause, what should I do if there were cause?
     ~Don Quixote~

Ryusui

  • Hero Member
  • *****
  • Posts: 4989
  • It's the greatest day.
    • View Profile
    • Tumblr
Re: Help writing a readme file.
« Reply #2 on: July 13, 2011, 06: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.
In the event of a firestorm, the salad bar will remain open.

Mauron

  • Sr. Member
  • ****
  • Posts: 472
    • View Profile
Re: Help writing a readme file.
« Reply #3 on: July 14, 2011, 08:36:09 am »
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.
Mauron wuz here.

Klarth

  • Sr. Member
  • ****
  • Posts: 484
    • View Profile
Re: Help writing a readme file.
« Reply #4 on: July 14, 2011, 10: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

  • Jr. Member
  • **
  • Posts: 66
    • View Profile
Re: Help writing a readme file.
« Reply #5 on: July 15, 2011, 01: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.
I  support Pandora's Box!
Released Hacks: FF6 Hard Challenge and Chrono Trigger Ingame loading
Coming Soon: Matsumi - Saga 1