Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up documentation on compilation #412

Merged
merged 10 commits into from
Mar 6, 2020

Conversation

mgunyho
Copy link
Contributor

@mgunyho mgunyho commented Mar 5, 2020

This is resolves #408.

I removed some duplicate information across the documentation related to compilation. Here are markdown files corresponding to wiki pages with some changes.

  • I removed all detailed compilation instructions from the main README and build/README.md and made them link to the wiki instead.
  • I changed links saying "for detailed instructions, see build/README" to point to the wiki
  • The first part of the compilation section in the manual is left mostly intact (so there is a bit of duplicate info), but I removed the more advanced instructions and added links to the wiki.
  • The MSVC/MSYS2 specific instructions are still in build, I added links to those in the wiki pages
  • There was a section 'Notes regarding the backends compilation' in the build/README that wasn't in the wiki, I added it to the backends wiki page. Not sure how relevant or up to date it is.
  • I also added some small changes to the embedding manual page

I tried to make sure that everything that was removed from the MD's is in the wiki files.

I'm not that familiar with CMake so if you find any mistakes, please feel free to correct them.

@dfober dfober merged commit 7bca542 into grame-cncm:master-dev Mar 6, 2020
@dfober
Copy link
Member

dfober commented Mar 6, 2020

That's fine! Thanks!

@mgunyho mgunyho deleted the compilation-docs-improve branch March 6, 2020 08:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation on compiling libfaust
2 participants