You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The installation instructions are really great! However, they encompass a lot of steps and that can dissuade the less intrepid from continuing to get things set up.
If your scripts are normalized by name across all of your projects, your contributors only need to know the pattern, not a deep knowledge of the application. This means they can jump into a project and make contributions without first learning how to bootstrap the project or how to get its tests to run.
I've seen a lot of OSS projects follow it. You don't have to follow it, but I mention it because it's a nice practice.
For example, it recommends a bootstrap script for installing dependencies. I'd that the Oncoscape ./script/bootstrap script would not only install the dependencies, but also set the environment variables needed to run the app.
For example, in the installation instructions for Windows you have this:
If you'd rather build and install the R packages in a alternate location (such as your home folder), first create a direcotry to hold the packages, then set the "R_LIBS" Windows System environment variable to point at the target folder
and
you'll need to create a directory to store user data and create a new Windows System environment variable named "ONCOSCAPE_USER_DATA_STORE" with a value of file://c:\path\userdata" (replacing the "path" and "userdata" with the correct path and target directory on your system.
I would suggest just having the bootstrap script create subfolders in %LocalAppData\oncoscape such as %LocalAppData%\oncoscape\R-packages and %LocalAppData\oncoscape\userdata and just use those. Here's a case where most developers don't really need to care much about this and having some opinionated defaults goes a long way. If they really care, they can either set this up manually or modify the script.
The text was updated successfully, but these errors were encountered:
The installation instructions are really great! However, they encompass a lot of steps and that can dissuade the less intrepid from continuing to get things set up.
At GitHub we have a set of scripts we include in just about every project.
I've seen a lot of OSS projects follow it. You don't have to follow it, but I mention it because it's a nice practice.
For example, it recommends a bootstrap script for installing dependencies. I'd that the Oncoscape
./script/bootstrap
script would not only install the dependencies, but also set the environment variables needed to run the app.For example, in the installation instructions for Windows you have this:
and
I would suggest just having the
bootstrap
script create subfolders in%LocalAppData\oncoscape
such as%LocalAppData%\oncoscape\R-packages
and%LocalAppData\oncoscape\userdata
and just use those. Here's a case where most developers don't really need to care much about this and having some opinionated defaults goes a long way. If they really care, they can either set this up manually or modify the script.The text was updated successfully, but these errors were encountered: