Skip to content

Update README for Hilary and UI #243

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

Merged
merged 10 commits into from
Feb 8, 2013

Conversation

mrvisser
Copy link
Contributor

Update README for Hilary to include an update on using paths with spaces.

Also, the UI README needs to be update to explain how the UI should be run.

@nicolaasmatthijs
Copy link
Contributor Author

This should also incorporate trentm/node-bunyan#58.

@ghost ghost assigned mrvisser Jan 17, 2013
@nicolaasmatthijs
Copy link
Contributor Author

A commit was done by @BP323 yesterday to improve the README. However, the following things still need to be added:

  • Do a section for Installing Dependencies and a section for Running Hilary.
  • When we talk about forking and cloning Hilary, we should also tell them to fork and clone 3akai-ux into the same directory, and clarify that 3akai-ux is the UI.
  • Show start command for Redis in similar way to the others
  • Move Nginx to the bottom of the dependencies, and explain where the config file should come from and which substitutions should be made
  • Show start command for RabitMQ in similar way to the others, and explain what it is used for
  • Add link to GraphicsMagick and PDFTK websites
  • Inside of Start Hilary, we should also explain how a tenant can be created and what should be entered as the host.
  • We should explain that hosts will need to be added to /etc/hosts for custom hosts to work

@mrvisser
Copy link
Contributor

@nicolaasmatthijs Re: the bunyan issue. I'll just add a tip that things may be generally unstable if you have spaces in your paths, and should be avoided. If there are / aren't known issues with this, that state will change rather randomly (perhaps sinusoidal?) through time.

@nicolaasmatthijs
Copy link
Contributor Author

Sounds good.

@stuartf
Copy link
Contributor

stuartf commented Jan 23, 2013

For the dependencies Windows users will need:

@nicolaasmatthijs nicolaasmatthijs merged commit 750bc0d into oaeproject:master Feb 8, 2013
@nicolaasmatthijs
Copy link
Contributor Author

Merged. Will update the 3akai-ux one as well and just make it a reference to this one.

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.

3 participants