Omnimaga
Calculator Community => TI Calculators => Lua => Topic started by: DJ Omnimaga on June 08, 2011, 03:42:16 pm
-
Please include a readme.txt file with your files in the future. I noticed a new trend in the community where all BASIC/Lua programmers no longer include a stand-alone readme.txt file with their games or programs. Instead, they include the readme directly inside the TNS file, and I even noticed more and more people who don't even include any instructions such as controls.
There used to only be two people that did that before, including a member here, but now it's almost every Nspire BASIC and Lua programmers.
Sometimes, I like to be able to check how the game operates prior installing it on my calc, to make sure it will not be too hard to play for me or to see if it's really what I expect (example, if it's an RPG and it says to type numbers then enter to move around instead of pressing arrows, I will not bother downloading it). However, when you put the readme directly inside the game document, this is impossible, as I am forced to load it on my calc, an emulator or a document player, and it's annoying.
So please, in the future, could you please do like TI-83 Plus, TI-89T and Casio programmers and make your readme.txt separate from the BASIC/Lua TNS files or both? Thanks.
-
I agree with this completely! :)
Actually, I have never even included the instructions in an Nspire document page, only in a separate ReadMe file. Most of the time, the contents of a ReadMe play a large role in whether I actually try a game!
-
On the 83+, when I see a RPG on ticalc, the first thing I look for is if the controls says "Press number keys to select stuff in the menus" and that there are no character movement control. This automatically tells me it's a menu-only RPG. Now those are uploaded in a separate directory on ticalc.org, but some still sneak in the regular RPG section from time to time.
-
Yeah, this is very true. I'll keep it in mind when I release my programs.
-
Better making a Readme readable by the calc (or even inside the prog) because when we send the prog to a friend, we can't always send the Readme.
-
Better making a Readme readable by the calc (or even inside the prog) because when we send the prog to a friend, we can't always send the Readme.
Or even better: Include both a separate readme as well as one inside the program.
-
Or even better than better : don't do any readme file. And we're fixed.
-
Better making a Readme readable by the calc (or even inside the prog) because when we send the prog to a friend, we can't always send the Readme.
Maybe but I still think an extra copy in txt format must be included, because someone who downloads the game might not bother installing it if he can't read the readme first.
Or even better than better : don't do any readme file. And we're fixed.
I would at least include instructions, but I don't work hard on readmes since a lot of people don't read them anyway :P
-
Or even better than better : don't do any readme file. And we're fixed.
:P
It's generally bad software practice to not include one or more of the following things with your program:
- License(s)
- README(s)
- Contact information
- Additional Disclaimers
- If it includes the source files:
- A build script / directions for building
- All tools used to compile the source
- License(s) for these
- Reminders in the main source files about the license(s) that apply
While most people don't include most of these, READMEs are absolute necessities and licenses are only second to that. I won't play a game with no README included in either a main or "about"/"resources" directory. I won't consider helping out with a project if it has no license.
-
I think a license isn't necessary. It's only necessary if you want people to help or re-use the code, for example. Personally I just put disclaimers in my readmes saying if the person can use the code or not.
-
Well, that technically can be considered a license, depending on what it applies to ;) with many calculator games it's fine (such as Axe or BASIC games). I think it's just a bit unthoughtful though if someone writes something that includes either source or extreme documentation, in a language like assembly, Lua, C, or even non-calc projects -- when there's a good chance your code will be stolen for later use. A disclaimer can work just fine, but for the paranoid like me the GPL v3 does wonders at protecting your work with some actual backing in court ;)
-
I wonder if they would want to deal with calculator games in court, though O.O
-
I plan to release source code with TI-Boy, but I don't expect people to understand it haha
-
I wonder if they would want to deal with calculator games in court, though O.O
Knowing the US legal system, maybe :P
-
This reminds me definitely. If you're making an 'official-like' release on ticalc.org there should definitely be a readme. Unfortunately there are just so many files out there with single document files in .zips, and some don't even have instructions within the game!
I myself am kinda guilty in not posting a full 'how-to-play' readme, just an informational readme. :D