How to handle the documentation?
Untill the program is ready, they might well be changed many times. Maybe we should use the CVS for docs also? Since LaTeX basicly is a plain textfile with some layoutcommands, it is easy to make small changes, like correcting spelingmisstakes, add a paragraph etc.
Besides this, what documentation are needed?
Here is my ideas:
MainDoc (Written in LaTex, distributed as .pdf and .html)
-Contains the main information about the programming language and how to handle the program.
MissionDoc (Written in LaTex, distributed as .pdf and .html)
-Contains information on how to write your own missions. (I suppose that also info about aliens shold be here.)
IsntallGuide (Might as well be plain text)
-How to isntall the program
ReadMe (Plain text)
-Main information, GPL license etc. Might also contain InstallGuide
icense.txt (plain text)
-The standard GNU-license text.
Did I miss anything?
/Nils-Arne
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
The benefit of CVS is that, provided you agree to work on different sections,
several people can conveniently work on one file at the same time.
Im not sure how the docs should be added.
They can be added file by file
or maybe imported as a subtree?
I don't know CVS very well.
On the aliens, I don't know maybe that should be an extended part of the manual
which doesn't come with the basic install. (The new player is not supposed to know about ****s until they've done the missions.)
>Did I miss anything?
I think those are all the user docs.
(And News or Changes - maybe that goes in the Readme.)
hmm you're too optimistic you left out Bugs :)
There is some source code documentation which should be somewhere in the source directory.
Documents which don't change eg the GPL license don't need to be in CVS.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
DONE!
The documentation has it own directory in the CVS now.
(I missed out the logmessage, but I dont think it matters...)
The latest version of the maindoc is at http://Fcomm.sourceforge.net/docs/
The text and layout is mostly OK I think. Comments, please!
Anyone how want to help out with the .mi-docs? I havnt written any missions myself, so I think I could need some help...
(BTW, our projct is the 18th most active this week!!)
/Nils-Arne
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Can you put instructions for how to check out the docs please.
>(BTW, our projct is the 18th most active this week!!)
It must be a slow week :)
I plan to do more to bring people when some more bugs are fixed and er you can try your own fleets without having to edit a mission file. And it would be good to get the preset missions available.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
If you allready have CVS installed and running on your computer, you just make a
cvs update
and you should get what you want. )Or so I hope..)
Information on CVS (and other things) can be found at http://sfdocs.sourceforge.net/sfdocs/
Please note that the information in the Win32/CVS/SSH Guide contains an error.
At one place (what you should place in your autoexec.bat) it says: (all on one line)
SET CVSROOT=username@cvs.projectname.sourceforge.net:/cvsroot/projectname
That is not correct...
it should be: (all on one line)
SET CVSROOT=:ext:username@cvs.projectname.sourceforge.net:/cvsroot/projectname
The :ext: is vital! If this variable is set to the right thing you will never need to use the -d switch.
So, what have I forgotten this time???
/Nils-Arne
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
How to handle the documentation?
Untill the program is ready, they might well be changed many times. Maybe we should use the CVS for docs also? Since LaTeX basicly is a plain textfile with some layoutcommands, it is easy to make small changes, like correcting spelingmisstakes, add a paragraph etc.
Besides this, what documentation are needed?
Here is my ideas:
MainDoc (Written in LaTex, distributed as .pdf and .html)
-Contains the main information about the programming language and how to handle the program.
MissionDoc (Written in LaTex, distributed as .pdf and .html)
-Contains information on how to write your own missions. (I suppose that also info about aliens shold be here.)
IsntallGuide (Might as well be plain text)
-How to isntall the program
ReadMe (Plain text)
-Main information, GPL license etc. Might also contain InstallGuide
icense.txt (plain text)
-The standard GNU-license text.
Did I miss anything?
/Nils-Arne
The benefit of CVS is that, provided you agree to work on different sections,
several people can conveniently work on one file at the same time.
Im not sure how the docs should be added.
They can be added file by file
or maybe imported as a subtree?
I don't know CVS very well.
On the aliens, I don't know maybe that should be an extended part of the manual
which doesn't come with the basic install. (The new player is not supposed to know about ****s until they've done the missions.)
>Did I miss anything?
I think those are all the user docs.
(And News or Changes - maybe that goes in the Readme.)
hmm you're too optimistic you left out Bugs :)
There is some source code documentation which should be somewhere in the source directory.
Documents which don't change eg the GPL license don't need to be in CVS.
DONE!
The documentation has it own directory in the CVS now.
(I missed out the logmessage, but I dont think it matters...)
The latest version of the maindoc is at http://Fcomm.sourceforge.net/docs/
The text and layout is mostly OK I think. Comments, please!
Anyone how want to help out with the .mi-docs? I havnt written any missions myself, so I think I could need some help...
(BTW, our projct is the 18th most active this week!!)
/Nils-Arne
Can you put instructions for how to check out the docs please.
>(BTW, our projct is the 18th most active this week!!)
It must be a slow week :)
I plan to do more to bring people when some more bugs are fixed and er you can try your own fleets without having to edit a mission file. And it would be good to get the preset missions available.
If you allready have CVS installed and running on your computer, you just make a
cvs update
and you should get what you want. )Or so I hope..)
Information on CVS (and other things) can be found at http://sfdocs.sourceforge.net/sfdocs/
Please note that the information in the Win32/CVS/SSH Guide contains an error.
At one place (what you should place in your autoexec.bat) it says: (all on one line)
SET CVSROOT=username@cvs.projectname.sourceforge.net:/cvsroot/projectname
That is not correct...
it should be: (all on one line)
SET CVSROOT=:ext:username@cvs.projectname.sourceforge.net:/cvsroot/projectname
The :ext: is vital! If this variable is set to the right thing you will never need to use the -d switch.
So, what have I forgotten this time???
/Nils-Arne
I have written a mission tutorial a while back. It should still be up to date. I will try to uploaded it tonight.
it is at http://aifcmissions.homepage.com
There is a HTML and a word version.