Skip to content

Commit

Permalink
Added website
Browse files Browse the repository at this point in the history
  • Loading branch information
complexlogic committed Apr 2, 2022
1 parent 88abf30 commit 182561b
Show file tree
Hide file tree
Showing 24 changed files with 1,639 additions and 145 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
docs/Gemfile.lock
docs/_site
docs/.jekyll-cache
4 changes: 2 additions & 2 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -361,8 +361,8 @@ if (UNIX)
configure_file("${PROJECT_SOURCE_DIR}/config/launcher.desktop.in" "${PROJECT_BINARY_DIR}/install/${EXECUTABLE_TITLE}.desktop")
install(FILES "${PROJECT_BINARY_DIR}/install/${EXECUTABLE_TITLE}.desktop" DESTINATION "${INSTALL_DIR_DESKTOP}")
set(INSTALL_DIR_ICONS "${CMAKE_INSTALL_PREFIX}/share/icons")
install(FILES "${PROJECT_SOURCE_DIR}/extra/flex-launcher.png" DESTINATION "${INSTALL_DIR_ICONS}/hicolor/48x48/apps")
install(FILES "${PROJECT_SOURCE_DIR}/extra/flex-launcher.svg" DESTINATION "${INSTALL_DIR_ICONS}/hicolor/scalable/apps")
install(FILES "${PROJECT_SOURCE_DIR}/docs/flex-launcher.png" DESTINATION "${INSTALL_DIR_ICONS}/hicolor/48x48/apps")
install(FILES "${PROJECT_SOURCE_DIR}/docs/flex-launcher.svg" DESTINATION "${INSTALL_DIR_ICONS}/hicolor/scalable/apps")
endif ()

# Set paths for config files
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ Flex Launcher is a customizable application launcher designed with a [10 foot us
Flex Launcher is compatible with both Windows and Linux (including Raspberry Pi devices).

## Screenshots
![Screenshot 1](extra/screenshots/screenshot1.png "Screenshot 1")
![Screenshot 1](extra/screenshots/screenshot2.png "Screenshot 2")
![Screenshot 1](docs/assets/screenshots/screenshot1.png "Screenshot 1")
![Screenshot 1](docs/assets/screenshots/screenshot2.png "Screenshot 2")

## Installation
Compiled binaries are available for Windows 64 bit, Linux x86-64, and Raspberry Pi. Alternatively, you may also choose to compile the program yourself using the [compilation guide](extra/docs/compilation_guide.md).
Compiled binaries are available for Windows 64 bit, Linux x86-64, and Raspberry Pi. Alternatively, you may also choose to compile the program yourself using the [compilation guide](docs/compilation.md).

### Windows
A win64 zip file is provided on the [release page](https://github.com/complexlogic/flex-launcher/releases). Simply download the file and extract the contents to a directory of your choosing. Flex Launcher should be run on an up-to-date Windows 10 system, or Windows 11.
Expand Down Expand Up @@ -89,7 +89,7 @@ If your config file is in one of the above locations, Flex Launcher can be start
```
flex-launcher -c /path/to/config.ini
```
Flex Launcher ships with a default config file which is intended strictly for demonstration purposes. If you try to start one of the applications, it is possible that nothing will happen because the install path is different on your system, or you don't have the application installed at all. See the [configuration file documentation](extra/docs/configuration.md) for instuctions on how to change the menus and settings.
Flex Launcher ships with a default config file which is intended strictly for demonstration purposes. If you try to start one of the applications, it is possible that nothing will happen because the install path is different on your system, or you don't have the application installed at all. See the [configuration file documentation](docs/configuration.md) for instuctions on how to change the menus and settings.

### Controls
The keyboard arrow keys move the highlight cursor left and right. Enter selects the current entry, backspace goes back to the previous menu (if applicable), and Esc quits the program.
Expand All @@ -98,7 +98,7 @@ The keyboard arrow keys move the highlight cursor left and right. Enter selects
Flex Launcher does not feature built-in decoding of IR or CEC signals. If you plan to use a TV remote to control the device, it is assumed that these signals are decoded by the OS or another program and mapped to keyboard presses, which can then be received by Flex Launcher. You can also use a hardware-based solution, such as the FLIRC USB device

#### Gamepads
Gamepad controls are built-in to the program, but are disabled by default. To enable them, open your configuration file, and, under the "Gamepad" section, change the "Enabled" setting from false to true. After that, the gamepad controls should "Just Work" for most users. If your gamepad is not recognized automatically, or you want to change the default controls, see the [gamepad controls documentation](extra/docs/configuration.md#gamepad-controls).
Gamepad controls are built-in to the program, but are disabled by default. To enable them, open your configuration file, and, under the "Gamepad" section, change the "Enabled" setting from false to true. After that, the gamepad controls should "Just Work" for most users. If your gamepad is not recognized automatically, or you want to change the default controls, see the [gamepad controls documentation](docs/configuration.md#gamepad-controls).

### Debugging
Flex Launcher has a debug mode which may be enabled as follows:
Expand All @@ -112,8 +112,8 @@ Contributions are welcome for bugfixes and new features. Please keep code format

## Documentation
Here is a list of available documentation:
- [Configuration File](extra/docs/configuration.md)
- [Compilation Guide](extra/docs/compilation_guide.md)
- [Configuration File](docs/configuration.md)
- [Compilation Guide](docs/compilation_guide.md)

## Credits
Flex Launcher is made possible by the following projects:
Expand Down
27 changes: 27 additions & 0 deletions docs/Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
source "https://rubygems.org"

gem "jekyll", "~> 4.2.2"
gem 'jekyll-seo-tag'
gem "jekyll-remote-theme"
#gem "github-pages", group: :jekyll_plugins

# If you have any plugins, put them here!
group :jekyll_plugins do
gem "jekyll-feed", "~> 0.12"
end

# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
# and associated library.
platforms :mingw, :x64_mingw, :mswin, :jruby do
gem "tzinfo", "~> 1.2"
gem "tzinfo-data"
end

# Performance-booster for watching directories on Windows
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]

# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
# do not have a Java counterpart.
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]

gem "webrick", "~> 1.7"
15 changes: 15 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
title: Flex Launcher
description: A customizable HTPC application launcher and front-end interface
url: "" # the base hostname & protocol for your site, e.g. http://example.com
github_username: complexlogic
repository: complexlogic/flex-launcher
launcher_version: 1.5

# Build settings
remote_theme: pages-themes/[email protected]
plugins:
- jekyll-feed
- jekyll-remote-theme
- jekyll-seo-tag


8 changes: 8 additions & 0 deletions docs/_data/menu.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
- title: Home
link: /
- title: Download
link: /download
- title: Configuration
link: /configuration
- title: Setup Guide
link: /setup
67 changes: 67 additions & 0 deletions docs/_layouts/default.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
<!DOCTYPE html>
<html lang="{{ site.lang | default: "en-US" }}">

<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width,maximum-scale=2">
<link rel="stylesheet" type="text/css" media="screen" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
<link rel="shortcut icon" type="image/png" href="/assets/icons/favicon.png">

{% seo %}
{% include head-custom.html %}
</head>

<body>

<!-- HEADER -->
<div id="header_wrap" class="outer">
<header class="inner">
{% if site.github.is_project_page %}
<a id="forkme_banner" href="{{ site.github.repository_url }}">View on GitHub</a>
{% endif %}

<h1 id="project_title" style="padding-bottom:0px;">{{ site.title | default: site.github.repository_name }}</h1>
<h2 id="project_tagline" style="margin-top:0px; margin-bottom:0px; padding-bottom:0px;">{{ site.description | default: site.github.project_tagline }}</h2>
<nav>
<ul>
{% for item in site.data.menu %}
{% if page.title == item.title or page.url == item.link %}
<li class="menu_no_link">{{item.title}}</li>
{% else %}
<li class="menu_link"><a href="{{item.link}}" class="menu_link">{{item.title}}</a></li>
{% endif %}
{% unless forloop.last %}
<li class="menu_no_link">|</li>
{% endunless %}
{% endfor %}
</ul>
</nav>
{% if site.show_downloads %}
<section id="downloads">
<a class="zip_download_link" href="{{ site.github.zip_url }}">Download this project as a .zip file</a>
<a class="tar_download_link" href="{{ site.github.tar_url }}">Download this project as a tar.gz file</a>
</section>
{% endif %}
</header>
</div>

<!-- MAIN CONTENT -->
<div id="main_content_wrap" class="outer">
<section id="main_content" class="inner">
{{ content }}
</section>
</div>

<!-- FOOTER -->
<div id="footer_wrap" class="outer">
<footer class="inner">
{% if site.github.is_project_page %}
<p class="copyright">{{ site.title | default: site.github.repository_name }} maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a></p>
{% endif %}
<p>Published with <a href="https://pages.github.com">GitHub Pages</a></p>
</footer>
</div>
</body>
</html>

Loading

0 comments on commit 182561b

Please sign in to comment.