search

AdamsLair / duality

a 2D Game Development Framework
https://adamslair.github.io/duality
MIT License
1.41k stars 286 forks source link

Write guidelines on how to switch to the new v4 template #799

Open Barsonax opened 4 years ago

Barsonax commented 4 years ago

Summary

There needs be a small guide on how to switch and use the new duality template https://github.com/Barsonax/DualityProjectTemplate

It should mention the differences in workflow between v3 and v4

Barsonax commented 4 years ago

Iam thinking its best for ppl to simply start from scratch and copy their source files into the new template. Since .cs files are included by default that should just work. Other files with different extensions do have to be added to the csproj.

Next is that we have to explain the workflow which isn't that different from v3 actually. Compile the solution, launch duality and your are good to go. Recompiling after a change should make duality reload the changed code.

ilexp commented 4 years ago

This should technically be moved to the docs repo, though I guess that would hurt the general overview on works regarding the current milestone, so let's keep it here. The docs repo is where the PR for this would be spawned though.

Since this will be released with a major version step (v4), we'll also need to bump / clone the docs version and create a changelog page, which should include an Upgrade Guide that could provide the required steps to go from v3 to v4.

Besides that, v4 will need an updated Getting Started page, and likely a new Requirements overview.

Barsonax commented 4 years ago

This should technically be moved to the docs repo, though I guess that would hurt the general overview on works regarding the current milestone, so let's keep it here. The docs repo is where the PR for this would be spawned though.

We could make separate issues (per article that has to be updated?) in the docs repo and just use this issue as a meta issue.

EDIT: Before I forget since coroutines will be new we should mention them somewhere in the docs as well I believe.

ilexp commented 4 years ago

Sounds good 👍

ilexp commented 4 years ago

List of specific docs issues to address for v4.0, sorted from highest to lowest priority:

I can probably jump in and help out with some of them as well. @Barsonax Do we have a recent alpha release of Duality and the template that I can work with?

Edit: Oh, wait a second. I just saw that a lot of them already have pending PRs by you. Nevermind in that case, let's take care of them first.

ilexp commented 4 years ago

Some of the above PRs have been merged, others are still WiP and I added another one for updating the changelog page. Here's a link to the v4 milestone in the docs repo, which should provide an overview on where we are with the docs right now.