Code documentation

An area for discussing new ideas and additions to Oolite.

Moderators: winston, another_commander

User avatar
Day
---- E L I T E ----
---- E L I T E ----
Posts: 545
Joined: Tue Mar 03, 2015 11:35 am
Location: Paris

Re: Code documentation

Post by Day »

Integrated! Thanks another_commander :-)

Edit: well, not quite yet integrated, I missed your edits.
another_commander
Quite Grand Sub-Admiral
Quite Grand Sub-Admiral
Posts: 6682
Joined: Wed Feb 28, 2007 7:54 am

Re: Code documentation

Post by another_commander »

I also note that the formatting of the original page has been lost and code now appears embedded in the text. Needs fixing.
User avatar
Day
---- E L I T E ----
---- E L I T E ----
Posts: 545
Joined: Tue Mar 03, 2015 11:35 am
Location: Paris

Re: Code documentation

Post by Day »

Right.
User avatar
Day
---- E L I T E ----
---- E L I T E ----
Posts: 545
Joined: Tue Mar 03, 2015 11:35 am
Location: Paris

Re: Code documentation

Post by Day »

@another_commander

I fixed the formatting by copying the existing wiki part on building the source code on windows, and made clear that it is possible to code by cloning the master branch without creating a branch at github. Done :-)

Edit: Hmm, what do you think of moving the "Building from source" from "Running Oolite-Linux" in this page too?
another_commander
Quite Grand Sub-Admiral
Quite Grand Sub-Admiral
Posts: 6682
Joined: Wed Feb 28, 2007 7:54 am

Re: Code documentation

Post by another_commander »

Day wrote:
Edit: Hmm, what do you think of moving the "Building from source" from "Running Oolite-Linux" in this page too?
I believe it makes sense to have all instructions for building in one page, but the important thing for me is that the Developing for Oolite page maintains continuity, simplicity and accuracy. The page should be easy to read and follow by a novice user who has just discovered Oolite and tries to see how to play with its code and at the same time be precise in its content. While I believe the Windows part is Ok at this moment, I would suggest that before any other content gets removed from existing pages, this Developing page gets finalized and reviewed first.
User avatar
Day
---- E L I T E ----
---- E L I T E ----
Posts: 545
Joined: Tue Mar 03, 2015 11:35 am
Location: Paris

Re: Code documentation

Post by Day »

I agree.

I have copied the content of "Building from source" from "Running Oolite-Linux" to "Developing Oolite", and then reorganized the page a little.
I hope it's clearer now.

What do you think?
Post Reply