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

Consider renaming build #10

Open
ahojukka5 opened this issue Dec 15, 2021 · 1 comment
Open

Consider renaming build #10

ahojukka5 opened this issue Dec 15, 2021 · 1 comment

Comments

@ahojukka5
Copy link

This library is not compatible with a "standard" cmake build

mkdir build && cd build
cmake ..
make

because the source files are in a directory called "build" (which is kind of non-intuitive anyway..). To make this library easier to use in applications, I would suggest restructuring the package (applying) as follows (https://hsf-training.github.io/hsf-training-cmake-webpage/06-projectstructure/index.html):

code/03-structure/
├── CMakeLists.txt
├── README.md
├── apps
│   ├── CMakeLists.txt
│   └── app.cpp
├── cmake
│   └── FindSomeLib.cmake
├── docs
│   ├── CMakeLists.txt
│   └── mainpage.md
├── include
│   └── modern
│       └── lib.hpp
├── src
│   ├── CMakeLists.txt
│   └── lib.cpp
└── tests
    ├── CMakeLists.txt
    └── testlib.cpp
  • external api published in include/p3dfft.3/p3dfft.h (or should it be p3dfft.3.h?)
  • internal header files and source files in src
  • tests in tests
@dmitrypek
Copy link
Contributor

Thank you for all of your suggestions. One thing to clarify: for users of the library the internal structure should not be an issue. We are not using cmake at this time, instead we are using autoconf. Users can specify --prefix in configure options, which will install the library in the location of their choice, with include/, lib/ and share/ directories. I like your idea of separating the internal and external header files, and will work on it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants