Input/ideas?

Getting Started Newbie Questions
#1

This is not exactly a Corona question, but I need some help.

CBEffects has been out for a while now, and I was wondering how I might make the readme. Right now the readme is extremely “messy” and difficult to read. All of the parameters are in a list, making it a bit tedious. And finally, the file itself is enormously long.

Does anyone have previous experience with writing comprehensive and complete documentation to something without making it pages and pages long and with making it easy to read?

I’d be glad for any input.

Caleb [import]uid: 147322 topic_id: 34592 reply_id: 334592[/import]

#2

One way is to use HTML, it is sort of the industry standard for marking up a page of text. You could write it in a word professor like Microsoft’s Word, Apple’s equivalent then output it as a PDF file for people to download and read (or include in your package). You could use Google Docs if you wanted to just have a doc version.

You can also research “Markdown” format, which is a lightweight way to layout pages as opposed to the verbose HTML tags.
[import]uid: 199310 topic_id: 34592 reply_id: 137569[/import]

#3

One way is to use HTML, it is sort of the industry standard for marking up a page of text. You could write it in a word professor like Microsoft’s Word, Apple’s equivalent then output it as a PDF file for people to download and read (or include in your package). You could use Google Docs if you wanted to just have a doc version.

You can also research “Markdown” format, which is a lightweight way to layout pages as opposed to the verbose HTML tags.
[import]uid: 199310 topic_id: 34592 reply_id: 137569[/import]