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

README suggestions #2

Open
galenwp opened this issue Oct 28, 2015 · 1 comment
Open

README suggestions #2

galenwp opened this issue Oct 28, 2015 · 1 comment

Comments

@galenwp
Copy link

galenwp commented Oct 28, 2015

I made some (mostly formatting) changes to the README here: https://github.com/galenwp/Saga (raw .md: https://raw.githubusercontent.com/galenwp/Saga/master/README.md).

I'd send a PR, but I think there's probably more that can be done. So I'll just throw some thoughts out there, let me know what you think, and I can submit a PR if it seems good.

  • For savvy users the installation instructions could be as simple as 'db config is here, site root is here'. Then you could have a more involved step-by-step guide for less savvy folks.
  • Maybe usage should start with the basics. What URL should I open to start? How do the parts fit together?
  • Where do I download the 'Saga_one' template? Oh wait, I found it.
  • If I want to upload it, where is the admin interface? This would probably be covered by some basic usage instructions.
  • Couldn't find site.js — usually a good idea to talk about files as full paths (if it's in the repo), or even better, just a link like https://raw.githubusercontent.com/matdryhurst/Saga/master/Templates/Saga_One/index.html

Glad to see this in public!

@matdryhurst
Copy link
Owner

Thanks Galen. It's cool, someone has already started working on a docker app! Having some issues with apache setup that need to be resolved and I agree with all of these amendments

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

No branches or pull requests

2 participants