Skip to content

Commit

Permalink
[CHORE] Assets, index.html fix + README conf + Build changes for CI
Browse files Browse the repository at this point in the history
  • Loading branch information
nots1dd committed Jan 12, 2025
1 parent e7b8bab commit 0f54333
Show file tree
Hide file tree
Showing 7 changed files with 49 additions and 5 deletions.
27 changes: 27 additions & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,36 @@ else()
target_link_libraries(${EXECUTABLE_NAME})
endif()

# Ensure that pkg-config is available
find_package(PkgConfig REQUIRED)

# Try to find GLib and Gio using pkg-config
pkg_check_modules(GLIB REQUIRED glib-2.0 gio-2.0)

# If pkg-config is not available or fails to find the libraries, fall back to manual search
if (NOT GLIB_FOUND)
message(STATUS "pkg-config not found or failed to find GLib and Gio, attempting manual search...")

# Try searching for the libraries using standard system directories
find_library(GLIB_LIBRARY NAMES glib-2.0 gio-2.0)

if (NOT GLIB_LIBRARY)
message(FATAL_ERROR "GLib and Gio libraries not found. Install libglib-2.0-dev and libgio-2.0-dev.")
endif()

# Manually find the include directories for GLib and Gio
find_path(GLIB_INCLUDE_DIR glib.h)
find_path(GIO_INCLUDE_DIR gio.h)

# If the includes or libraries are not found, give an error
if (NOT GLIB_INCLUDE_DIR OR NOT GIO_INCLUDE_DIR)
message(FATAL_ERROR "GLib and Gio include files not found.")
endif()

set(GLIB_LIBRARIES ${GLIB_LIBRARY})
set(GLIB_INCLUDE_DIRS ${GLIB_INCLUDE_DIR} ${GIO_INCLUDE_DIR})
endif()

# Add include directories for glib and gio
include_directories(${GLIB_INCLUDE_DIRS})
link_directories(${GLIB_LIBRARY_DIRS})
Expand Down
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ A possible revamp of LiteMus

<div align="center">
<img src="assets/gifs/inLimbo-1.gif" alt="inLimbo Demo GIF" width="600">
<img src="assets/gifs/inLimbo-3.gif" alt="inLimbo Demo GIF" width="600">
</div>

## DEPENDENCIES
Expand Down Expand Up @@ -162,7 +163,7 @@ There is quite a lot to configure in the inLimbo project. A basic config file wi
>
<div align="center">
<img src="assets/gifs/inLimboColors.gif" alt="inLimbo Demo GIF" width="600">
<img src="assets/gifs/inLimbo-2.gif" alt="inLimbo Demo GIF" width="600">
</div>

## DIRECTORY SORTING
Expand Down Expand Up @@ -204,9 +205,19 @@ To generate and view doxygen documentation locally:
```bash
doxygen .Doxyfile # ensure that you have doxygen installed first
cp -r assets/gifs/ docs/
cp index.html docs/
firefox docs/html/index.html # or any web browser (xdg-open also works)
```
It is much easier to use the script `make_docs.sh`

```bash
./make_docs.sh
```

Or you could just visit [inLimbo Website](https://nots1dd.github.io/inLimbo/)

## CREDITS

**LOGO**:
Expand Down
Binary file modified assets/gifs/inLimbo-1.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/gifs/inLimbo-2.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/gifs/inLimbo-3.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,9 @@ <h2>Features</h2>
</section>

<section class="section images">
<img src="../gifs/inLimbo-1.gif" alt="inLimbo Screenshot 1">
<img src="../gifs/inLimboColors.gif" alt="inLimbo Screenshot 2">
<img src="image3.jpg" alt="inLimbo Screenshot 3">
<img src="gifs/inLimbo-1.gif" alt="inLimbo Screenshot 1">
<img src="gifs/inLimbo-2.gif" alt="inLimbo Screenshot 2">
<img src="gifs/inLimbo-3.gif" alt="inLimbo Screenshot 3">
</section>

<section class="section licensing">
Expand All @@ -122,7 +122,7 @@ <h2>Author</h2>

<!-- Button to Doxygen Documentation -->
<div class="button-container">
<a href="../../docs/html/index.html" target="_blank">Visit the Doxygen Documentation</a>
<a href="html/index.html" target="_blank">Visit the Doxygen Documentation</a>
</div>
</div>

Expand Down
6 changes: 6 additions & 0 deletions make_docs.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#!/bin/bash

doxygen .Doxyfile
cp -r assets/gifs/ docs/
cp index.html docs/
xdg-open docs/index.html

0 comments on commit 0f54333

Please sign in to comment.