iScsc / iscsc.fr

The iScsc website, build with passion by wannabe devs 🔥
GNU General Public License v3.0
4 stars 12 forks source link

Additional changes to README #114

Open OlaPom opened 1 year ago

OlaPom commented 1 year ago

Hello again! This PR is for some additional changes I would like to suggest to your file. They are loosely inspired by technical writing style guides(such as Google Developer Style Guide or Microsoft Style Guide).

  1. “Functionalities” - I focused on the language and rephrased some sentences that seemed too complicated (to me).
  2. “Deployment” - this part is a real fun with all these different task descriptions :) I suppose that the file will change as your website develops, so I don’t want to suggest any revolution in the structure. However, I think that these writing tips would help keep it organised:
  3. “Repository structure” - it says that it’s a list of the main files and folders. Does it mean you want to have only the most important files listed here or all of them? I can update the list with the names of the missing files, but you would have to add the descriptions.
  4. Screenshots - if the interface changes frequently, then there is no point in adding screenshots, but I think it might be a good idea for the future.

    Issue #106