ttocskcaj Posted January 23, 2011 Share Posted January 23, 2011 Hey, not sure if this is the best place, but I'm not the best at writing. So if someone would like to proof read my readme file quickly it would be much appreciated. https://github.com/ttocskcaj/The-Forum-Framework/blob/master/README.md Quote Link to comment Share on other sites More sharing options...
requinix Posted January 23, 2011 Share Posted January 23, 2011 In terms of the writing it seems fine. Is this is a readme like the kind packaged with the application files? You don't need to try to sell the product to whomever at that point ("easy to adapt", "you can simply create"): they've decided to check it out and are looking at the README for basic instructions. As a developer I want more than just a couple paragraphs explaining what the thing can do. I want to know where I should start playing around with it. Some important questions: - Where are the files located? - What's the file structure? - Anything I need to edit beforehand? - Where can I find more information? Documentation? Support forums? Find a PHP developer friend who isn't familiar with TFFW and give them a copy of the README and application files. See what they would do. Then see how you can make the experience better. Think of it this way: It doesn't matter how good the system and its code are if I don't know how to use them. Quote Link to comment Share on other sites More sharing options...
ttocskcaj Posted January 23, 2011 Author Share Posted January 23, 2011 Cool, that's exactly what I wanted It's not finished yet, so the readme will change as a build it up to a proper release. Right not, it's just a basic description of what it can/might do. I will probably make a manual on the wiki. Quote Link to comment Share on other sites More sharing options...
Recommended Posts
Join the conversation
You can post now and register later. If you have an account, sign in now to post with your account.