search

campus-experts / spring-2017

19 stars 21 forks source link

Wrote a README #52

Open catherinechung opened 7 years ago

catherinechung commented 7 years ago

I decided to update the README of a group project that I worked on this semester. Since the project is pretty simple, I didn't know what else to add besides a description of the project, installation, and license. Let me know what else I could add! Link to the README is here.

elliotblackburn commented 7 years ago

Big fan of the project, it looks awesome! I really like the description you've added at the top under the tag line, it's really specific and I knew exactly what the project which often isn't the case with other projects.

I had a three suggestions which you might fund helpful, no pressure though they're just aesthetic really.

  1. If you've got a series of shell commands to execute, you can add them all into a "block" using triple backticks (rather than the single that you've used there) and you can even get syntax highlighting going on. A bit like below, check out the guide here (I just set the language to bash).
cd server
php composer.phar install
php composer.phar start
  1. Personally I don't tend to include guides for installing dependencies such as node and npm. If you include it then it tends to mean you've got to keep on top of installation changes for their tech. Maybe find a guide and link to it at the top of the setup and then just list the npm install http-server -g steps.

You'll need php, nodejs and npm (which is bundled with nodejs).

  1. Maybe include a picture of the application in action so people can see a sample of what they might get. As your project is totally visual you might find it conveys a lot of what you've said in the "purpose" section, or it could complement it well.

Great readme, I'll have to give this project a go a bit later as well, it looks fun. Oh I also love the name!