DragonPrime - LoGD Resource Community
Welcome Guest
  • Good morning, Guest.
    Please log in, or register.
  • September 19, 2018, 10:28:36 AM
Home Forums News Downloads Login Register Advanced Search
* * *
DragonPrime Menu
Login
 
 
Resource Pages
Search

Pages: [1]   Go Down
  Print  
Author Topic: read me .txt  (Read 3647 times)
0 Members and 1 Guest are viewing this topic.
Jim
Guest
« on: February 10, 2005, 02:09:38 PM »

I really like the fact that CortalUX is adding read me files to his .zips. When I first arrived here I was surprised that this wasn't a standard already. Might I suggest this be a standard? I always feel a little bad for making suggestions like this because I feel as if I do not contribute enough to the community. So if any one is offended by me suggesting this please let me apologize in advance.
Logged
Sichae
iMod God
SVN Users
Mod God
*
Offline Offline

Posts: 3458


If ya didn't get it by now... you're hopeless...


View Profile WWW
« Reply #1 on: February 10, 2005, 02:15:16 PM »

I really wouldn't enjoy doing that, as I just like to zip my file, then upload. I don't really want to take the time, to put them both into a folder, or write up a readme in the first place, then zip it up.

My time is very precious to me. Besides, most modules only need this for a readme "Drop into /modules, go to Grotto, install."

Sorry if this sounds brash, but I have not been doing too well in the past couple of weeks...
« Last Edit: February 10, 2005, 02:17:42 PM by Sichae » Logged

If you didn't understand anything in the above post, don't try to attempt anything suggested.

CortalUX
Dwellings Project
Mod God
*****
Offline Offline

Posts: 796


Wogga! Meep!


View Profile WWW
« Reply #2 on: February 10, 2005, 02:24:54 PM »

I never actually used to do this, and then enderwiggin notified me that my stuff was extracting into /desktop..
I made two folders stable and unstable, each of which had a zip folder, one folder for each mod, and a default readme where I could put information and whatever it requires.
so it is:
Stable
-readme.txt
-amod/
--readme.txt
--amod.php
-zips/
--amod.zip
Unstable
-readme.txt
-zips/

Takes a while to organize, but it speeds things up, as with ultimatezip you can just right-click to turn 'whateverfolder' into 'whateverfolder.zip.
Logged
Elessa
Faerie
Mod God
*****
Offline Offline

Posts: 3598


short, sweet and to the point


View Profile
« Reply #3 on: February 10, 2005, 02:26:04 PM »

I really wouldn't enjoy doing that, as I just like to zip my file, then upload. I don't really want to take the time, to put them both into a folder, or write up a readme in the first place, then zip it up.

My time is very precious to me. Besides, most modules only need this for a readme "Drop into /modules, go to Grotto, install."

Sorry if this sounds brash, but I have not been doing too well in the past couple of weeks...

i hope ye are kidding, right? because there are some folk who are very new to this and may need that simple "drop into/modules, go to grotto, install" info. an extra three minutes is going to be well worth the time taken to create the text doc and folder to make a module more user friendly before zipping it.

what jim is suggesting and what some of the coders are already doing with a readme.txt is an excellent idea. i hope more of ye will do likewise.
Logged

Uuma ma ten rashwe, ta tuluva a lle

Play the latest beta version here on LoGD DragonPrime - Axebridge
Sichae
iMod God
SVN Users
Mod God
*
Offline Offline

Posts: 3458


If ya didn't get it by now... you're hopeless...


View Profile WWW
« Reply #4 on: February 10, 2005, 02:26:56 PM »

I just have a folder on my Desktop labeled Modules, and it contains all of my mods, in their respective folder. When I update one, I update it in the folder, then I save it to my Desktop, right click-> Add to Archive -> Zip, Done. Then, I upload.

That is about as organized as I ever want/will be.
Logged

If you didn't understand anything in the above post, don't try to attempt anything suggested.

Talisman
Administrator
Mod God
*****
Offline Offline

Posts: 5479



View Profile WWW
« Reply #5 on: February 10, 2005, 02:32:16 PM »

The same could be accomplished with a comment block within the module itself:

Code:
/*mynewmodule.php
Installation:  Place this file in your modules folder
What it does:  Gives players a new shop to go into
Settings:  Admin can configure number of items and cost of each
Comments:  This module tested and compatible with pre-release 13
*/

The problem with trying to establish a 'standard' is that there is no requirement for anyone to adhere to that standard.  We can come up with suggested or desired practices, but that is about the best one can really ask.

Oh yeah, and Jim:  This community can only improve when the people using our creations (and creating our creations) make suggestions which they feel will enhance the service.  Keep them coming.
« Last Edit: February 10, 2005, 02:34:28 PM by Talisman » Logged

Play the latest beta version here on DragonPrime
Sichae
iMod God
SVN Users
Mod God
*
Offline Offline

Posts: 3458


If ya didn't get it by now... you're hopeless...


View Profile WWW
« Reply #6 on: February 10, 2005, 02:37:19 PM »

* Sichae sighs and twitches

All files of mine have bene uploaded with a Generic Readme...

And Talisman: I did do that for a while, but it slowly grew monotonous... so I stopped.
« Last Edit: February 10, 2005, 02:37:52 PM by Sichae » Logged

If you didn't understand anything in the above post, don't try to attempt anything suggested.

Talisman
Administrator
Mod God
*****
Offline Offline

Posts: 5479



View Profile WWW
« Reply #7 on: February 10, 2005, 02:46:57 PM »

Which is why I said coming up with a 'standard' isn't feasible.  Do it or not, your choice.
Logged

Play the latest beta version here on DragonPrime
lonnyl
Guest
« Reply #8 on: February 10, 2005, 04:31:26 PM »

I really like the fact that CortalUX is adding read me files to his .zips. When I first arrived here I was surprised that this wasn't a standard already. Might I suggest this be a standard? I always feel a little bad for making suggestions like this because I feel as if I do not contribute enough to the community. So if any one is offended by me suggesting this please let me apologize in advance.

Listen here you worthless peice of....  Grin Just Kidding... I have done a couple of readme files but only when there is a little something odd with the install.....
Logged
Arune
Member
Mod God
*****
Offline Offline

Posts: 718


Arune Vai - khatfield


View Profile WWW
« Reply #9 on: February 10, 2005, 08:28:00 PM »

I'm not organized  Grin

My server is where I run my files and do my edits... Because I'm too lazy to keep it all synchronized on my machine... I GZip them on my server, download them to my desktop PC. Wherever I maybe...(Work/On Road/Home)

Make my final edits...Zip and Upload... Delete

Original is always on the server and quite honestly putting files in folders is kind of a pain imo. It adds another step... So does Xoops but anyway..

Normal Process:
lynx http://www.whatever.com/grabfile.zip
D - for download
Enter - Save
Y - To overwrite my archived zip file
unzip module.zip
cp *.php ../modules

then if in a folder....for sake of cleanliness delete the folder.


Problem I was going to mention with Xoops...
Links/Lynx - Using a non-redirected/scripted URL I can easily...

Copy link
lynx (paste link here)

and takes me directly to the file...

But if its a redirect.. it adds more steps and complicates the process. But thats just because it is in a textual non-loving of redirects browser Tongue

Anyway....My point is!
Updating the game...Updating modules...Writing modules...Keeping my players happy... is very time consuming.

I'd really rather to not add *ANY* more steps or responsibility to the processes. Smiley Good idea for some but not for others... Which is why Talisman said what he did.

Now as a side note:
This is more or less standard for all 0.9.7 modules. Either a readme file or a notation at the beginning of the file. Installation was so much more involved and needed proper instructions. 0.9.8...Still is beta so really the normal everyday user shouldn't be running it without having some knowledge of the internal workings. Also the installations are much easier and really if someone can't install a *stable* module in 0.9.8 something is wrong.

And by the way Jim, never worry about making a suggestion. You are part of this community as well. Making rational suggestions such as this is a contribution.
« Last Edit: February 10, 2005, 08:45:42 PM by Arune » Logged
Jim
Guest
« Reply #10 on: February 11, 2005, 02:27:37 AM »

Thanks guys for making me feel I can have a voice even though I think 'standard' was a bad choice of words now.  Grin


Logged
Pages: [1]   Go Up
  Print  
 
Jump to:  


*
DragonPrime Notices
Welcome to DragonPrime - The LoGD Resource Community!

Support Us
No funds raised yet this year
Your help is greatly appreciated!
Recent Topics
DragonPrime LoGD
Who's Online
30 Guests, 0 Users
Home Forums News Downloads Login Register Advanced Search