From: Mike H. <ar...@pe...> - 2002-10-17 20:50:56
|
Joern, Be very careful. It looks like you're talking yourself into re-writing t= he code docs ;o) I think that would be an excellent idea. I don't know how much they need to change but to have someone in charge of this would be great. Monitoring the devel list and code changes and beating all us cod= ers until we update the docs would be a very useful thing to do. ----- Original Message ----- From: "Joern P.Meier" <ari...@io...> To: <ari...@li...> Sent: Sunday, October 13, 2002 5:01 PM Subject: Re: [Arianne-general] Key Code questions > On Sun, 13 Oct 2002 05:22:45 +0100 > "SkyFlash" <web...@ha...> wrote: > > > Well, all our clients are working on both linux AND windows right now= . > > I think we should try to keep it that way, so we dont need a team for= > every OS. > > Yes. Most code can be programmed in such a way that usage of > OS-dependent code is minimized and contained within abstraction API. Th= e > rest is (hopefully) just standard C++, so anyone can program it like he > knows it should be done. It should then, in theory, run on any platform= . > ;) > > A dedicated team for each OS is probably not needed, however, people ar= e needed who make sure that the conceptually platform-independent code does indeed compile on any platform. > > > > How many code-bases are there? > > There are three really. > > 1. The old one, which is working, and thats in arianne/ everywhere. > > That old is nice, works, and was the old codebase for the last > > release. > > > > Advantage: it works. its proven. > > Disadvantages: > > - its not possible to create a real working game with it > > [...] > > 2. The one I am currently working on, and thats in arianne/newcommon > > and arianne/newserver > > [...] > > Advantage: extensible, future oriented. When its done it will make > > real games possible. Optimized. > > Disadvantages: > > - It doesnt compile > > [...] > > - Its too much work for someone not REALLY into the whole Arianne > > code to get the hang of it and program on it, unless she/he is a ver= y > > experienced programmer. > > [Rest] > > Well, I have been programming for 8 years now, and although there's > still much for me to learn, there are aspects in the Arianne developmen= t > process that keep puzzling me. > > For example, Miguel recently stated that documentation was a waste of > time, and the barrier for new developers should be raised. From my > experience, I can state that there was never any API that appeared > worthwhile if it was not properly and thoroughly documented. That means= , > I came to regard good documentation as one of the primary objectives in > software development. This also holds true for choosing an API among > several candidates. I have now arrived at a point at which I can develo= p > software using almost any API, if, and only if, it is well documented. > > What do I want to say, after all? I think you (or we) should take some > time discussing the Arianne architecture (first step), document it, and > then develop an API that conforms to the architecture (second step). > Both of these steps should be documented in the form of RFCs or the > like. In the end, there must be a well written architecture and API > documentation in intelligible english (or any number of other languages= ) > that any interested developer can download, read, and understand. I > suggested the model of RFCs because I consider it the best approach to > develop standards in an open source community. > > If no one wants to do the "paperwork", maybe there's something after al= l > that I could contribute to the Arianne project, even with my limited > time resources. I read a lot of API documentation, I also write a lot, > so tell me what you think about it. If you, however, believe in running > code first rather than consensus first, then there's probably no point > with my statement. :) > > Regards, > > J=F6rn > > P.S.: The only documentation I have seen so far is the Arianne code > book. However, I think it documents the codebase as described above as > 1, the one that is not usable for a real working game. Furthermore, It > is not easy to understand, repeats itself and does not contain any > documentation on real API. > > > ------------------------------------------------------- > This sf.net email is sponsored by: viaVerio will pay you up to > $1,000 for every account that you consolidate with us. > http://ad.doubleclick.net/clk;4749864;7604308;v? > http://www.viaverio.com/consolidator/osdn.cfm > _______________________________________________ > Arianne-general mailing list > Ari...@li... > https://lists.sourceforge.net/lists/listinfo/arianne-general > |