search

H-uru / Plasma

Cyan Worlds's Plasma game engine
http://h-uru.github.io/Plasma/
GNU General Public License v3.0
205 stars 80 forks source link

Update README to point to website instructions #1432

Closed dpogue closed 1 year ago

dpogue commented 1 year ago

It's better to maintain these in a single place rather than multiple places where they can get out of date and out of sync (although yes it would be nice for the instructions to be available after cloning the repo).

Also update the list of libraries to keep it accurate.

dgelessus commented 1 year ago

although yes it would be nice for the instructions to be available after cloning the repo

A possible solution: currently the website is on its own gh-pages branch, but GitHub Pages also supports putting the website files in a "docs" folder on the default branch, which would be easily accessible in a local checkout. I can think of some minor downsides to doing this, but overall it would be more convenient than the current situation.

A small difficulty is that we already have a "Docs" folder on the master branch, so you can't also have a "docs" folder on a case-insensitive file system. Though perhaps it would be a good opportunity to make those docs available on the website somewhere?