synfig / synfig-docs-dev

Developer's documentation of Synfig
https://synfig-docs-dev.readthedocs.io/
6 stars 27 forks source link

Reorder title contents #65

Closed Keyikedalube closed 4 years ago

Keyikedalube commented 4 years ago
  1. [x] After the user sets up his IDE, he should be guided directly to Code structure Building Synfig and Dependencies are redundant because his IDE already takes care of that

  2. [x] Shouldn't Contributing guidelines be on top? Because this topic doesn't really have a chronological connection with previous and next. It's standalone just like Code of Conduct

  3. [x] Group Building Synfig (<- rename it to Autotools) and Synfig Using CMake together Just like NetBeans and QtCreator are grouped together under a single IDE topic

  4. [x] Merge Preparing Environment sub-topic from Autotools and CMake together in one single section under Building Synfig category

  5. [x] Move Package using CMake sub-topic from Synfig Using CMake to Packaging Synfig for distribution

Screenshot from 2020-09-12 10-47-16

So here's an outline of how I think the new ordering should be:

   - Contributing guidelines
   - Setting up your preferred IDE
   - Code structure
   - Building synfig
      > Preparing environment
      > Autotools
      > CMake
   - Packaging synfig
      > Autotools
      > CMake
   - Tutorials
   ...
ice0 commented 4 years ago

Agree.

Keyikedalube commented 4 years ago

@ice0 this is an easy issue too. Just reorganization needed. 👉 Hacktoberfest and easy 😁

ice0 commented 4 years ago

@Keyikedalube Done!

AYESDIE commented 4 years ago

The Preparing Environment part for building with Autotools and CMake is the same. So if we are going that way, that information can be merged.

Keyikedalube commented 4 years ago

I guess you mean something like this:

- Building synfig
      > Preparing environment
      > Autotools
      > CMake
AYESDIE commented 4 years ago

Yep, I mean something like this. Because both of those preparing environment parts go over the installation of dependencies using the script that we have given and it's the same for Autotools and CMake.

Keyikedalube commented 4 years ago

I'll make a PR for this this evening.