Updating the readme

Updating the readme

Various things about Spring that do not fit in any of the other forums listed below, including forum rules.

Moderator: Moderators

Post Reply
Fnordia
Former Engine Dev
Posts: 425
Joined: 13 Aug 2004, 16:11

Updating the readme

Post by Fnordia »

As you may have noticed, the readme.html that is supplied with the spring installer is getting a bit out of date. There's a lot of more current information in the wiki though, and I was hoping that someone would be willing to update the Readme which I imported into the wiki some time ago.

I created a little script that removes the wiki formatting from the Readme and makes it look like the current document that we distribute in the installer, here. The idea was that it could be used to export the readme for new releases.

It's possible that there is some better solution, such as including a few more articles such as the getting started etc with the installer. Or just linking to them on the site perhaps.
Gnomre
Imperial Winter Developer
Posts: 1754
Joined: 06 Feb 2005, 13:42

Post by Gnomre »

It'd probably be wise to include some multiplayer information, such as information on port forwarding and stuff for online play and maybe a local version of the LAN play doc as well.
Warlord Zsinj
Imperial Winter Developer
Posts: 3742
Joined: 24 Aug 2004, 08:59

Post by Warlord Zsinj »

Could you just dump the wiki and all its sub-pages into an offline-HTML file marked "Readme" which comes with Spring?
User avatar
SinbadEV
Posts: 6475
Joined: 02 May 2005, 03:56

Post by SinbadEV »

There is quite a bit of stuff that people "need" to know before trying to get online... Someone could try to have a look at the readme(I might after work but someone else will probably get to it before me) and make sure there's nothing essential missing from it or wrong and updating it with links to the wiki pages that can give people the rest of the instuctions... AKA http://taspring.clan-sy.com/wiki/Using_Spring and http://taspring.clan-sy.com/wiki/Getting_Started which are not complete but very useful as they are... with a general insitement to look over the wiki and forums for the latest news and info... anyone who is going to play sping online is going to have a connection to the internet so links should be fine... the wiki is updated at least daily somewhere so including a rip of it wouldn't really be all that helpful...
User avatar
PauloMorfeo
Posts: 2004
Joined: 15 Dec 2004, 20:53

Post by PauloMorfeo »

Please don't let this thread die.

If nothing else, beeing it Fnordia saying that it will just HTMLify what's on the wiki or something.
User avatar
PauloMorfeo
Posts: 2004
Joined: 15 Dec 2004, 20:53

Post by PauloMorfeo »

:( No better solution seems to be hapening...

I've done a mini-help system. You can find it here:
http://www.fileuniverse.com/?p=showitem&ID=1674
It's basically an HTMLification of parts of the wiki + some stuff in the original readme.
It's neat and simple. Seems to be working ok, even though it's nothing special.
The starting page is "main.html".

Beware i changed some few minor things. For example:
Before:
What is TA Spring?

TA Spring is a project to create the best RTS ever (no joke). There are three principle goals which we hope to achieve.

1. Reach a stage where TA Spring can flawlessly execute most of Total Annihilation's original gameplay, with its original units in their original format.
2. Add new features as we see fit, fix bugs, and release new versions when we feel it is appropriate to do so.
3. Support the mod community as we see fit.
After:
What is TA Spring?

TA Spring is a project to create the best RTS ever (no joke). There are three principle goals which we hope to achieve.

1. Reach a stage where TA Spring can flawlessly execute most of Total Annihilation's original gameplay, with its original units in an improved format.
2. Add new features as we see fit, fix bugs, and release new versions when we feel it is appropriate to do so.
3. Support the mod community as we see fit
Check it out to see if it is ok and if it suit your curent needs.

By the way, all the new pages were validated successfully through the W3 Markup Validation Service:
http://validator.w3.org/file-upload.html
The only page that failed that validation was "LICENSE.html" which is original from the game :P .
"No Character Encoding Found! Falling back to WTF-8."
User avatar
AF
AI Developer
Posts: 20687
Joined: 14 Sep 2004, 11:32

Post by AF »

finally, I can see it could do with an aesthetic overhaul badly though.

I can see a GroupAI could be made that added a small window with a html viewer inside, then the code could be integrated into the New GUI.

I'd try and integrate it myself but I dont know much about IE/mozilla controls or implementing html parsers, or how the new GUI code is layed out.
Post Reply

Return to “General Discussion”