OBLIVION
Pyros Software - Guidelines ReadMe and Description Page generator by daJbot
Oblivion » Utilities
Added: 20/11/2012 - 11:02AM
Updated: 18/03/2015 - 07:37PM

8 Endorsements

5.3.2 Latest version

128 Unique D/Ls

140 Total D/Ls

4,782 Total Views

Uploaded by daJbot

Description

Last updated at 19:37, 18 Mar 2015 Uploaded at 11:02, 20 Nov 2012


by Pyros Software


Version :5.3
Date :2015-03-18
Category :Utility
Author's Website :http://forums.nexusmods.com/index.php?showuser=2222832

Table of contents
  • Description
  • Author's Note
  • Supported BB Codes
  • Requirements
  • What's New?
  • How to get started?
  • Installation
  • Uninstallation
  • Contact
  • Credits
  • Frequently Asked Question
  • Tools Used
  • Legal and Licensing



Description
Welcome to Guidelines 2015. A program designed with one purpose in mind… To reduce the time, effort and complexity involved when designed documentation for a modification.

Documentation is an integral part of a mod as it informs your current users as well as introduce new users to the features on changes made by it. Therefore having a good clear description is a must. This application provides an easy to use interface to allow you, the author to quickly set up a formal and professional ReadMe, be that on your mod’s page or a RTF file packaged with your mod.


Author's Note
I am always looking for new ideas and features, or improving current features. But in order for me to know that a feature needs more attention or to find out if their are bugs I need your help. Please report and suggest on the comment page. Thank you for using Guidelines :)


Supported BB Codes
  • Bulleted Lists
  • Numbered Lists
  • Alphabetical Lists
  • Bold
  • Italic
  • Underline
  • Center Text
  • Right Text
  • Colored Text
  • Normal Linking
  • Named Linking
  • Images
  • Youtube videos



Requirements



What's New?
  • Converted offline ReadMe's to use RTF format allowing more customization in the future. This makes the title header setting change the color of offline ReadMe's as well.
  • Updated the Masterlists to V2
  • Moved the "Mod Settings" area into the navigation bar for consistency and easy access.
  • The number of words in each section is now counted and displayed at the bottom of the screen. It will also display the total words when viewing the ReadMe
  • Aesthetics improvements to title bar.
  • Reduced the default Size of the Readme viewers to support smaller resolutions.
  • Added ScriptExtenders for Fallout NV, Fallout 3, Oblivion and Skyrim all linking to their respected download page.



How to get started?
Generating a readme is pretty easy with this tool. But to help you get started and introduce the new interface, follow these steps.

Step One:

When you first open the you will notice a Navigation pane on your left. The headings section will display the current headings that will be included in your readme. At the bottom of this pane is "Create Custom" and "Remove Selected" buttons. Create custom allows you to create a custom heading. If you would like to pick a default heading, head over to the "Default Categories" tab in the navigation bar and tick all the topics you would like to be added.

When you select a heading in the "Headings" section the display will change to allow you to edit that heading:



The "Use image as header" option, when ticked, will replace the default "Description:" header with an image. (Please note: You will have to upload an image to any website and just paste its Url into the appropriate box.)

The "Mod Settings" button allows you to change the info that will be displayed at the top of the ReadMe page. (For users of previous version, this is where the info found on "Page One" has been moved.)



When the BB codes option is turned on you can access the Tools section of the Ribbon. This is where BB codes comes into play.



When your done you can click on "Generate ReadMe". This will take all the information you added into each heading and turn it into a description page. For Offline( BB codes disabled) ReadMe's hit "Save as .txt" for Online (BB codes enabled) ReadMe's hit "Copy to Clipboard" or select all and press Ctrl + C. Then paste it into your Nexus mod description edit area.

If you are the type of person that takes his/her time with created a readme to make sure you have everything... You can save the ReadMe as a .grmx file and load and edit it when you please.


Installation
  • Download 7 Zip if you don't already have it.
  • Download .Net Framework V4.5.1 if you don't already have it.
  • Extract the downloaded Guidelines 2015.7z file
  • Run Guidelines 2015 Setup.exe
  • Follow the on screen instructions



Uninstallation
  • Go to Control Panel
  • Add or Remove Programs
  • Scroll down to Guidelines 2015
  • Select it and hit uninstall at the top



Contact
  • Using the comment section on any of the Nexus sites hosting this program.
  • Email: pyrossoft@gmail.com



Credits
Icon Set and Lead Programmer:
Jano Bodenstein

ColorPicker Control:
Xceed Wpf Extended Toolkit

MahApps.Metro UI Toolkit
MahApps.Metro


Frequently Asked Question
My description looks great when previewing it while editing the description, but the formatting messes up when hitting accept.
Unfortunately this seems to be a bug on the Nexus site. It is completely out of my control and must be fixed by the Nexus.

Why can I "Download with Manager"
This has been done so you can se if a new version of this program is available. Do not install it with a mod manager as it will then just copy the "Guidelines 2015 Setup.exe" to your Skyrim directory or "..\Mod organizer\Mods\"(Mod Organizer users) folder.

I want a portable version!
The program installes a set of requirements. In order for the program to work correctly (And display icons for .grmx files as well as open them when double clicking them in windows explorer) it needs to run an installer to make sure everything installs correctly.


Tools Used



Legal and Licensing
The content of this mod is owned by me, you may not use it under any circumstances. This Program is Freeware and is provided free of charge, no one may sell it to you. As it is freeware feel free to tell anybody to download it. It is strictly hosted on Fallout 3, Oblivion, Skyrim and New Vegas Nexus sites, if you find it on another site please let me know.

Also although it isn't essential to include the auto generated line linking to this utility, I greatly would appreciate it if you would leave it there, I made it small and placed it at the bottom so it doesn't take away from your readme.

ReadMe generated with: Guidelines 2015