[Readme] Reformatting, add "Contributing" and "Help" sections #4082
Conversation
johnsaigle
added
Category: Documentation
johnsaigle
changed the title
johnsaigle
changed the title
johnsaigle
changed the title
johnsaigle
added
Area: UI
README.md
Outdated
| include details such as the version of LORIS you're using as well as information | ||
| such as the OS you're using, your PHP and Apache versions, etc. | ||
|
|
||
| ### Community |
There was a problem hiding this comment.
Community isn't a subset of help. Help is a subset of community.
README.md
Outdated
| * Apache2 | ||
| * MySQL 5.7 | ||
| * PHP <b>7.2</b> | ||
| * Package manager (for LINUX distributions) | ||
| * Composer : should be run with --no-dev option | ||
| * A package manager, e.g. `apt` |
There was a problem hiding this comment.
Apache 2.4
MySQL 5.7+ or MariaDB 10.3+
PHP 7.2 or higher
We had a discussion on that in #3976
There was a problem hiding this comment.
Hm yes I think I based this off of minor before the changes in 3976 were merged. I'll update the dependencies
Co-Authored-By: johnsaigle <[email protected]>
Co-Authored-By: johnsaigle <[email protected]>
Co-Authored-By: johnsaigle <[email protected]>
|
would it be possible in step 4 of install, Or would it be for another PR? If a new PR is required, I approve this one. |
|
I don't really know much about the difference between the two. From this post it seems like What's is your preference for using the lower-level command over this one? |
|
service is the old form. With systemD, systemctl is the new way to do it. If you call service with SystemD, a wrapper will pass the call to systemctl for backward compatibility (not exhaustive). Lower level command is systemctl as no wrapper is involved |
|
Apart from one being old and another new I'm still not sure why we would need to change the command here. Anyway I think this is probably a topic for a different PR since this is mostly just a formatting change. |
|
|
||
| LORIS (Longitudinal Online Research and Imaging System) is a web-based data and project management software for neuroimaging research. LORIS makes it easy to manage large datasets including behavioural, clinical, neuroimaging and genetic data acquired over time or at different sites. | ||
| LORIS (Longitudinal Online Research and Imaging System) is a self-hosted web application that provides data- and project-management for neuroimaging research. LORIS makes it easy to manage large datasets including behavioural, clinical, neuroimaging and genetic data acquired over time or at different sites. |
There was a problem hiding this comment.
This paragraph is extremely bolded by this PR.
Brief summary of changes
Made a bunch of changes to the presentation of the Readme. This is obviously very subjective so let me know what you think.
I mainly tried to reduce duplication, change the format to highlight the most important areas, and encourage readers to open issues and reach out to us generally.
Also removed the build status chart and replaced it with the
masterbuild status which was placed beside the title.