Update README.md #28
Update README.md #28
Conversation
|
@kiryteo can you please squash all commits together (they all have the same title)? |
|
Yes, sorry for the mess, I'll squash the commits. |
README.md
Outdated
|
|
||
| - ROOT's package manager prototype | ||
|
|
||
| root-get is the project centric package manager for ROOT. The application provides simplified build and install process for ROOT packages and modules. |
There was a problem hiding this comment.
Can we mention here also that we work with external packages too?
There was a problem hiding this comment.
ok, I have explained it later but I'll add here too.
README.md
Outdated
|
|
||
| The directory path where user can get the installed package/module. | ||
|
|
||
| - ROOTSYS |
There was a problem hiding this comment.
Not exactly, ROOTSYS is also the directory where you unpacked the ROOT (e.g. ROOT base)
There was a problem hiding this comment.
Here, Line 31 is the explanation for ROOT_PKG_PATH, for ROOTSYS the explanation is below it.
| deps: 'dependencies' | ||
| ``` | ||
|
|
||
| - Example module.yml : |
There was a problem hiding this comment.
yes, actually it would be good thing to do.! thanks.!
README.md
Outdated
|
|
||
| python3 | ||
|
|
||
| [matplotlib](https://matplotlib.org/users/installing.html) |
There was a problem hiding this comment.
what is a command that user will need to use to install matplotlib and networkx?
There was a problem hiding this comment.
The links are directed to official installation instructions only.
README.md
Outdated
|
|
||
|
|
||
| ## Initial setup | ||
| Required - root build files directory, if not present already, do an out of source build for root |
There was a problem hiding this comment.
Lets remove installation of ROOT base package from here (it is not really belongs to steps how to setup root-get)?
There was a problem hiding this comment.
I will move it in docs/setup-ROOTbase.md
There was a problem hiding this comment.
Sure, I'll create a separate file setup-ROOTbase.md and add there
README.md
Outdated
|
|
||
| ## Installing | ||
|
|
||
| To install a new module with root-get : |
There was a problem hiding this comment.
Can we add here all other options we have? "-mi", "-pi", "-s", "-l" and etc.
There was a problem hiding this comment.
Yes, I'll do it. with subheadings for each of these.
README.md
Outdated
| ``` | ||
| $ mkdir installdir | ||
| ``` | ||
| Inside the root-get directory, set environment variables |
There was a problem hiding this comment.
why only inside root-get directory?:)
There was a problem hiding this comment.
Need to remove this.. its not necessary.
|
I have added the discussed modifications and updated the readme. |
kiryteo
force-pushed
the
add-readme
branch
2 times, most recently
from
5aa9358 to
a5d04d0
Compare
|
@oshadura I have updated the README, please have a look and suggest if any changes are required.. |
- Added example module manifest - self hosted repository, no third party usage - Added commands with respect to recent changes
No description provided.