Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move the script files outside the root directory #13

Closed
yungyuc opened this issue Apr 13, 2021 · 6 comments
Closed

Move the script files outside the root directory #13

yungyuc opened this issue Apr 13, 2021 · 6 comments
Assignees
Labels
enhancement New feature or request question Further information is requested

Comments

@yungyuc
Copy link
Member

yungyuc commented Apr 13, 2021

I don't think we should leave script files in the root directory.

Also, we would need a simple document to tell users how to use the tool.

@yungyuc yungyuc added the question Further information is requested label Apr 13, 2021
@yungyuc
Copy link
Member Author

yungyuc commented Apr 15, 2021

@tai271828 @j8xixo12 @chestercheng any thoughts?

@j8xixo12
Copy link
Collaborator

In my opinion, where to leave script files should let the user decide?

@yungyuc
Copy link
Member Author

yungyuc commented Apr 15, 2021

In my opinion, where to leave script files should let the user decide?

Agree. But at the moment we have four executable script files in the repository root:

build-pybind11-in-conda.sh*
conda.sh*
devenv-cli.sh*
prepare-solvcon-dev.sh*

If staying there, they will be mixed with script files added by users. The mixture may discourage users from placing script files in the root directory, and thus limit their options.

What should we do with our script files?

@tai271828
Copy link
Collaborator

In my opinion:

  1. The four scripts are orthogonal to devenv management tool. The four scripts are helpers to build SOLVCON and perform a simple function test. The devenv management tool is a in-house source package management tool (specifically built for SOLVCON)
  2. The four scripts are delivered as a kick-starter, and the goal is to replace most of its dependency management by our own tool, a.k.a. devenv management tool currently. See Discuss the use of miniconda for installing dependencies #4 (comment)

Thus, my gut feeling shows:

  1. move devenv-cli.sh to bin, and probably rename it with a better name.
  2. more the other scripts (conda.sh ...etc. totally 3 of them) to an individual folder, e.g. solvcon, application-solvcon, or examples/solvcon.

@yungyuc
Copy link
Member Author

yungyuc commented Apr 16, 2021

In my opinion:

  1. The four scripts are orthogonal to devenv management tool. The four scripts are helpers to build SOLVCON and perform a simple function test. The devenv management tool is a in-house source package management tool (specifically built for SOLVCON)

Agree the orthogonality and the reason.

  1. The four scripts are delivered as a kick-starter, and the goal is to replace most of its dependency management by our own tool, a.k.a. devenv management tool currently. See #4 (comment)

Agree. And we should make it clear that they are so in the file organization.

Thus, my gut feeling shows:

  1. move devenv-cli.sh to bin, and probably rename it with a better name.
  2. more the other scripts (conda.sh ...etc. totally 3 of them) to an individual folder, e.g. solvcon, application-solvcon, or examples/solvcon.

It sounds like a plan. Any estimate for when there will be a PR?

@tai271828
Copy link
Collaborator

In my opinion:

  1. The four scripts are orthogonal to devenv management tool. The four scripts are helpers to build SOLVCON and perform a simple function test. The devenv management tool is a in-house source package management tool (specifically built for SOLVCON)

Agree the orthogonality and the reason.

  1. The four scripts are delivered as a kick-starter, and the goal is to replace most of its dependency management by our own tool, a.k.a. devenv management tool currently. See #4 (comment)

Agree. And we should make it clear that they are so in the file organization.

Thus, my gut feeling shows:

  1. move devenv-cli.sh to bin, and probably rename it with a better name.
  2. more the other scripts (conda.sh ...etc. totally 3 of them) to an individual folder, e.g. solvcon, application-solvcon, or examples/solvcon.

It sounds like a plan. Any estimate for when there will be a PR?

ETA: by the up-coming Monday! (pity. the message box of github does not allow emoji?!)

@yungyuc yungyuc added the enhancement New feature or request label Apr 17, 2021
@yungyuc yungyuc changed the title What to do with the script files in the root directory? Move the script files outside the root directory Apr 17, 2021
tai271828 added a commit to tai271828/devenv that referenced this issue Apr 17, 2021
tai271828 added a commit to tai271828/devenv that referenced this issue Apr 17, 2021
tai271828 added a commit to tai271828/devenv that referenced this issue Apr 17, 2021
@yungyuc yungyuc closed this as completed Apr 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants