Make readme great again #41
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
orzechow
requested changes
Dec 5, 2024
README.md
Outdated
| @@ -100,20 +130,20 @@ docker compose build | |||
| docker compose run --rm util_caching | |||
| ``` | |||
|
|
|||
| The library is installed in the Docker image under `/usr/local/include/util_caching/` and `/usr/local/lib/cmake/util_caching/`. | |||
| The library is installed in the Docker image under `/usr/include/util_caching/` and `/usr/lib/cmake/util_caching/`. | |||
There was a problem hiding this comment.
That's probably not correct for the docker image, as we haven't set CMAKE_INSTALL_PREFIX here (as we did in arbitration_graphs).
Thus, the install location of util_caching is different for
- a local install via cmake/make (as in our last docker stage)
→/usr/local/include/util_caching - and a
.debarchive install
→/usr/include/util_caching
I'd avoid forcing the install prefix in the CMakeLists.txt, as was necessary for the arbitration_graph GUI…
We could set it in the Docker though:
RUN cmake -DCMAKE_INSTALL_PREFIX="/usr" .. && \
cmake --build . && \
cmake --install . && \
rm -rf /tmp/util_cachingThere was a problem hiding this comment.
Oh, I see. I thought it was just outdated because I have the .deb version installed locally. I don't think forcing another path is necessary. I corrected the path in 1988385.
ll-nick
force-pushed
the
make_readme_great_again
branch
from
1988385 to
636b89d
Compare
|
I just rebased on main and integrated the parts about the python bindings into the feature list and the usage documentation. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This tidies up the readme in the style we use in the arbitration_graphs repo.
This moves large parts of the existing readme into collapsible spoilers, adds shield.io badges, and a list of features.
#patch