mirror of
https://github.com/clockworkpi/wiki.clockworkpi.com.git
synced 2025-12-12 08:48:51 +01:00
replace Main.md
This commit is contained in:
cuu
parent
7fdc6b163b
commit
3109ba53c8
374
_wiki/Main.md
374
_wiki/Main.md
@ -1,258 +1,126 @@
|
|||||||
---
|
---
|
||||||
layout: simple
|
layout: simple
|
||||||
title: Main Page
|
title: Main_Page
|
||||||
created: 2009-04-12
|
|
||||||
modified: 2009-04-12
|
|
||||||
revisions:
|
revisions:
|
||||||
- author: Alexis
|
- author: Cuu
|
||||||
date: 2009-04-12
|
date: 2024-02-22
|
||||||
comment: First version
|
comment: First version
|
||||||
---
|
---
|
||||||
|
Welcome to the ClockworkPi community wiki!
|
||||||
# Why ?
|
|
||||||
|
## Gameshell
|
||||||
I wrote this template in 2019 because I wanted to migrate a mediawiki-powered wiki to jekyll.
|
|
||||||
|
### What is GameShell?
|
||||||
The template has a layout and a navigation that can replace my old wiki.
|
|
||||||
|
GameShell is an open source portable game console made by
|
||||||
# How to
|
[ClockworkPi](https://www.clockworkpi.com/) after a successful
|
||||||
|
[Kickstarter
|
||||||
If you want to use this template, clone the [repository](https://github.com/jek4wik/jek4wik), customize it and write _wiki_ pages.
|
campaign](https://www.kickstarter.com/projects/954662076/gameshell-redefine-retro-game-console)
|
||||||
|
in 2018.
|
||||||
## Settings
|
|
||||||
|
<figure>
|
||||||
The general settings are in the _config.yml file.
|
<img src="img/GameShell_W.png" title="GameShell_W.png" />
|
||||||
|
<figcaption>GameShell_W.png</figcaption>
|
||||||
You may choose the *language*.
|
</figure>
|
||||||
English (en) and french (fr) are supported out-of-the box.
|
|
||||||
|
### Getting started
|
||||||
```yaml
|
|
||||||
lang: en
|
- [Assembly](Assembly "wikilink") - Follow the assembly manual came with
|
||||||
```
|
GameShell to assemble the parts.
|
||||||
|
- [Up and Running](Up_and_Running "wikilink") - You've assembled your
|
||||||
You may customize the *collections*.
|
GameShell and powered it on, now what?
|
||||||
The only contraint is that the name of collections containing wiki pages should start with wiki.
|
- [SSH](SSH "wikilink") - Connect GameShell with your computer for
|
||||||
|
transferring files and configurations.
|
||||||
```yaml
|
- [Emulators](Emulators "wikilink") - How to configure your emulators
|
||||||
collections:
|
and how to add ROMs.
|
||||||
wiki-one:
|
- [Pico-8](Pico-8 "wikilink") - How to install Pico-8, a cute fantasy
|
||||||
output: true
|
console on your GameShell.
|
||||||
permalink: "/:path"
|
- [Troubleshooting](Troubleshooting "wikilink") - Launcher not loading?
|
||||||
path: ""
|
Cannot connect to WiFi? Check here for solutions to common problems.
|
||||||
wiki-two:
|
- [Glossary](Glossary "wikilink") - Learn the jargons!
|
||||||
output: true
|
- [Linux resources](Linux_resources "wikilink") - New to Linux? Don't
|
||||||
permalink: "/:path"
|
panic!
|
||||||
path: ""
|
|
||||||
special:
|
### Hardware
|
||||||
output: true
|
|
||||||
permalink: "/:path"
|
- [GameShell hardware info](GameShell_hardware_info "wikilink") -
|
||||||
path: ""
|
Information about GameShell's mainboard, screen, battery, keypad,
|
||||||
```
|
speaker and Lightkey module
|
||||||
|
- [GPIO](GPIO "wikilink") - Interact with the real world with General
|
||||||
Of course, you'll have to change the other site settings like title, description or url.
|
Purpose Input/Output lines!
|
||||||
|
- [3D Models](3D_Models "wikilink") - 3D models of GameShell parts for
|
||||||
## i18n
|
3D printing, including community designed custom parts.
|
||||||
|
- [Bluetooth](Bluetooth "wikilink") - Connect other devices using
|
||||||
The labels are in i18n files in the `_data/i18n` directory.
|
bluetooth
|
||||||
|
|
||||||
These files contain also prefixes for special pages, the name of home page and the logo that will be displayed on the top left.
|
### Software
|
||||||
|
|
||||||
```yaml
|
- [Kernel](Kernel "wikilink") - CPI Linux Kernel
|
||||||
home: Main
|
- [Launcher](Launcher "wikilink") - The launcher of games and apps in
|
||||||
logo: /img/wiki.png
|
GameShell
|
||||||
label:
|
- [Warehouse](Warehouse "wikilink") - Libraries of browsable and
|
||||||
author: Author
|
downloadable games, like those developed in [GameShell
|
||||||
links: Links
|
Jams](GameShell_Jams "wikilink")
|
||||||
tags: Other pages
|
- [Compatible emulators](Compatible_emulators "wikilink") - NES, SNES,
|
||||||
...
|
Genesis/MD, PS1, you name it!
|
||||||
prefix:
|
- [Compatible game engines](Compatible_game_engines "wikilink") -
|
||||||
tag: "Category:"
|
Pygame, LÖVE2D, Pico-8, Tic-80...
|
||||||
user: "User:"
|
- [Compatible games](Compatible_games "wikilink") - List of standalone
|
||||||
```
|
games such as CaveStory, ChocoDM.
|
||||||
|
|
||||||
## Users
|
## DevTerm
|
||||||
|
|
||||||
The users are declared in the _data/users.yml file.
|
### What is DevTerm?
|
||||||
|
|
||||||
```yaml
|
Devterm is an open source portable terminal for every Dev!
|
||||||
Alexis:
|
|
||||||
name: Alexis Hassler
|
<figure>
|
||||||
logo: img/sewatech.png
|
<img src="img/DevTerm_fig01.webp" title="DevTerm_fig01.webp" />
|
||||||
```
|
<figcaption>DevTerm_fig01.webp</figcaption>
|
||||||
|
</figure>
|
||||||
Each user should have its page in the `_special` directory.
|
|
||||||
The name of this page starts with the prefix defined in the i18n file (here `User:`)
|
### Getting started
|
||||||
and end with the user short name (here `Alexis`).
|
|
||||||
|
[Assembly](Devterm_Assembly "wikilink") - Follow the assembly manual
|
||||||
# Wiki pages
|
came with DevTerm to assemble the parts.
|
||||||
|
|
||||||
Wiki pages are in collections that name starts with wiki.
|
[Batteries](Batteries "wikilink") - The 18650 batteries are NOT included
|
||||||
The bootstrap project provides 2 collections : `wiki` and `wiki-legacy`.
|
in the package due to global logistics complexity for lithium batteries
|
||||||
|
|
||||||
The pages can be written in HTML, Markdown or Asciidoc.
|
### Hardware
|
||||||
|
|
||||||
> Note: Asciidoc is not supported on Github pages.
|
- [Devterm hardware info](Devterm_hardware_info "wikilink") -
|
||||||
|
Information about DevTerm's mainboard, screen, battery, keyboard, and
|
||||||
## Regular wiki page
|
speaker modules
|
||||||
|
- [GPIO](GPIO "wikilink") - Interact with the real world with General
|
||||||
A regular wiki page should be place in a _wiki_ collection.
|
Purpose Input/Output lines!
|
||||||
The only required metadata in frontmatter is the layout.
|
- [3D Models](3D_Models "wikilink") - 3D models of DevTerm parts for 3D
|
||||||
The simplest page may be something like this:
|
printing, including community designed custom parts.
|
||||||
|
- [Bluetooth](Bluetooth "wikilink") - Connect other devices using
|
||||||
```yaml
|
bluetooth
|
||||||
---
|
- [EXT.](EXT. "wikilink") - Connect devices via the (non-standard)
|
||||||
layout: wiki
|
mPCI-E slot
|
||||||
---
|
- [CORE](CORE "wikilink") - Info about the CORE modules
|
||||||
Example with minimal frontmatter
|
- [Thermal Printer](Thermal_Printer "wikilink") - Print out your .TXT's
|
||||||
```
|
on the built-in printer!
|
||||||
|
|
||||||
The frontmatter may contain the following attributes:
|
### Software
|
||||||
|
|
||||||
* title: will be displayed on top of the page
|
- [Kernel](Kernel "wikilink") - CPI Linux Kernel
|
||||||
* author: will be displayed in a div in the left columns
|
- [ClockworkOS](ClockworkOS "wikilink") - The operating system for your
|
||||||
* toc: true/false wether you want a generated table of content
|
DevTerm
|
||||||
* created and modified: date in format yyyy-MM-dd
|
|
||||||
* revisions: not displayed (maybe for a future use)
|
### Howtos
|
||||||
|
|
||||||
> Note: the toc plugin doesn't work on Github pages
|
- [Manjaro on A06](Manjaro_on_A06 "wikilink") - Install Manjaro OS on
|
||||||
|
DevTerm A06
|
||||||
## Redirect page
|
- [How-Tos and Tweaks](How-Tos_and_Tweaks "wikilink")
|
||||||
|
|
||||||
A redirect page should be place in the _special_ collection.
|
## Community
|
||||||
It should have a frontmatter with a **layout** and a **redirect**, and no content
|
|
||||||
|
- [Forum](https://forum.clockworkpi.com/)
|
||||||
```yaml
|
- [Discord](https://discord.gg/XKGGkPM)
|
||||||
---
|
- [Github](https://github.com/clockworkpi)
|
||||||
layout: redirect
|
- [Twitter](https://twitter.com/Hal_clockwork)
|
||||||
redirect: New
|
- [Instagram](https://instagram.com/clockworkpi/)
|
||||||
---
|
- [GameShell Jams](GameShell_Jams "wikilink")
|
||||||
```
|
|
||||||
|
|
||||||
> Note: redirections may be managed in an other way with the _jekyll-redirect-from_ plugin
|
|
||||||
|
|
||||||
## Tag page
|
|
||||||
|
|
||||||
A tag page should be place in a _special_ collection.
|
|
||||||
The file name should have the prefix defined in the _i18n_ file and end with the tag name.
|
|
||||||
|
|
||||||
For example, a file named `Tag:Example.md` would fit with the following i18n configuration.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
prefix:
|
|
||||||
tag: "Tag:"
|
|
||||||
```
|
|
||||||
|
|
||||||
> Note: this is in the i18n files because mediawiki translates this prefix ; it is Category in english and Catégorie in french
|
|
||||||
|
|
||||||
The tag page may have the same metadata as a regular page.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
---
|
|
||||||
layout: tag
|
|
||||||
title: Example of Tag
|
|
||||||
tags: Example
|
|
||||||
toc: false
|
|
||||||
created: 2019-04-12
|
|
||||||
modified: 2019-04-12
|
|
||||||
revisions:
|
|
||||||
- author: Alexis
|
|
||||||
date: 2019-04-12
|
|
||||||
comment: First version
|
|
||||||
---
|
|
||||||
## Example Tag
|
|
||||||
|
|
||||||
Nice examples
|
|
||||||
```
|
|
||||||
|
|
||||||
## User pages
|
|
||||||
|
|
||||||
A user page should be place in a _special_ collection.
|
|
||||||
The file name should have the prefix defined in the _i18n_ file and end with the user name.
|
|
||||||
|
|
||||||
For example, a file named `User:Example.md` would fit with the following i18n configuration.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
prefix:
|
|
||||||
user: "User:"
|
|
||||||
```
|
|
||||||
|
|
||||||
> Note: this is in the i18n files because mediawiki translates this prefix ; it is User in english and Utilisateur in french
|
|
||||||
|
|
||||||
The user page may have the same metadata as a regular page.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
---
|
|
||||||
layout: user
|
|
||||||
title: Alexis
|
|
||||||
created: 2019-04-12
|
|
||||||
modified: 2019-04-12
|
|
||||||
---
|
|
||||||
I'm a developer.
|
|
||||||
```
|
|
||||||
|
|
||||||
# Deploy
|
|
||||||
|
|
||||||
The simplest way to deploy your wiki is to generate the site and copy it to a Web Server.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
jekyll build
|
|
||||||
```
|
|
||||||
|
|
||||||
As any Jekyll web site, the generation may be done on a CI server (TravisCI,...) or with the CI capabilities of the Git server (Gitlab, Github actions,...).
|
|
||||||
|
|
||||||
## Apache HTTP server
|
|
||||||
|
|
||||||
A `.htaccess` file is provided.
|
|
||||||
If the site is deployed on a Apache HTTP server, some old mediawiki URLs are rewritten to the new Jekyll URLs.
|
|
||||||
|
|
||||||
## Github pages
|
|
||||||
|
|
||||||
The wiki cannot be deloyed simply on Github pages because of unsupported filters and custom plugins.
|
|
||||||
|
|
||||||
If you want to deploy it on Github pages, you should push the generated site.
|
|
||||||
Any CI tool can help.
|
|
||||||
|
|
||||||
## Gitlab pages / CI
|
|
||||||
|
|
||||||
If your source code is hosted on Gitlab, you can deploy the wiki on Gitlab page.
|
|
||||||
The .gitlab-ci.yml provides a generic setup for that.
|
|
||||||
When you push on Gitlab, the file is be detected and a pipeline is run.
|
|
||||||
The wiki is then deployed on pages.
|
|
||||||
|
|
||||||
> Note: the deployment may occur several minutes after the end of the build.
|
|
||||||
|
|
||||||
With the provided configuration, Gitlab CI may also upload the site with SFTP.
|
|
||||||
|
|
||||||
Reference:
|
|
||||||
|
|
||||||
* [GitLab Pages](https://docs.gitlab.com/ee/user/project/pages/)
|
|
||||||
|
|
||||||
|
|
||||||
## Github actions
|
|
||||||
|
|
||||||
[TBD]
|
|
||||||
|
|
||||||
## TravisCI
|
|
||||||
|
|
||||||
[Travis CI](https://travis-ci.org/) can launch automatically the jekyll build and deploy the site.
|
|
||||||
|
|
||||||
The examples and this page are built this way.
|
|
||||||
The [repository](https://github.com/jek4wik/jek4wik) provides a `.travis.yml` configuration file wich deploy the built site on Github Pages.
|
|
||||||
If want to use it, just change the `repo` and setup your build on Travis CI with the GITHUB_TOKEN environment variable.
|
|
||||||
|
|
||||||
With the provided configuration, Travis CI may also upload the site with SFTP.
|
|
||||||
|
|
||||||
References:
|
|
||||||
|
|
||||||
* [Travis CI - GitHub Pages Deployment](https://docs.travis-ci.com/user/deployment/pages/)
|
|
||||||
* [Travis CI - Script deployment](https://docs.travis-ci.com/user/deployment/script/)
|
|
||||||
|
|
||||||
# Examples
|
|
||||||
|
|
||||||
* Example of a [new page](New)
|
|
||||||
* Example of a [legacy page](Old)
|
|
||||||
* Example of a [redirected page](Redirect)
|
|
||||||
* Example of a [user page](./User:Alexis)
|
|
||||||
* [RSS](feed.xml) feed of new pages
|
|
||||||
* Example of a [tag page](./Tag:Example)
|
|
||||||
* [All tags page](./tags)
|
|
||||||
|
|||||||
@ -1,126 +0,0 @@
|
|||||||
---
|
|
||||||
layout: simple
|
|
||||||
title: Main_Page
|
|
||||||
revisions:
|
|
||||||
- author: Cuu
|
|
||||||
date: 2024-02-22
|
|
||||||
comment: First version
|
|
||||||
---
|
|
||||||
Welcome to the ClockworkPi community wiki!
|
|
||||||
|
|
||||||
## Gameshell
|
|
||||||
|
|
||||||
### What is GameShell?
|
|
||||||
|
|
||||||
GameShell is an open source portable game console made by
|
|
||||||
[ClockworkPi](https://www.clockworkpi.com/) after a successful
|
|
||||||
[Kickstarter
|
|
||||||
campaign](https://www.kickstarter.com/projects/954662076/gameshell-redefine-retro-game-console)
|
|
||||||
in 2018.
|
|
||||||
|
|
||||||
<figure>
|
|
||||||
<img src="img/GameShell_W.png" title="GameShell_W.png" />
|
|
||||||
<figcaption>GameShell_W.png</figcaption>
|
|
||||||
</figure>
|
|
||||||
|
|
||||||
### Getting started
|
|
||||||
|
|
||||||
- [Assembly](Assembly "wikilink") - Follow the assembly manual came with
|
|
||||||
GameShell to assemble the parts.
|
|
||||||
- [Up and Running](Up_and_Running "wikilink") - You've assembled your
|
|
||||||
GameShell and powered it on, now what?
|
|
||||||
- [SSH](SSH "wikilink") - Connect GameShell with your computer for
|
|
||||||
transferring files and configurations.
|
|
||||||
- [Emulators](Emulators "wikilink") - How to configure your emulators
|
|
||||||
and how to add ROMs.
|
|
||||||
- [Pico-8](Pico-8 "wikilink") - How to install Pico-8, a cute fantasy
|
|
||||||
console on your GameShell.
|
|
||||||
- [Troubleshooting](Troubleshooting "wikilink") - Launcher not loading?
|
|
||||||
Cannot connect to WiFi? Check here for solutions to common problems.
|
|
||||||
- [Glossary](Glossary "wikilink") - Learn the jargons!
|
|
||||||
- [Linux resources](Linux_resources "wikilink") - New to Linux? Don't
|
|
||||||
panic!
|
|
||||||
|
|
||||||
### Hardware
|
|
||||||
|
|
||||||
- [GameShell hardware info](GameShell_hardware_info "wikilink") -
|
|
||||||
Information about GameShell's mainboard, screen, battery, keypad,
|
|
||||||
speaker and Lightkey module
|
|
||||||
- [GPIO](GPIO "wikilink") - Interact with the real world with General
|
|
||||||
Purpose Input/Output lines!
|
|
||||||
- [3D Models](3D_Models "wikilink") - 3D models of GameShell parts for
|
|
||||||
3D printing, including community designed custom parts.
|
|
||||||
- [Bluetooth](Bluetooth "wikilink") - Connect other devices using
|
|
||||||
bluetooth
|
|
||||||
|
|
||||||
### Software
|
|
||||||
|
|
||||||
- [Kernel](Kernel "wikilink") - CPI Linux Kernel
|
|
||||||
- [Launcher](Launcher "wikilink") - The launcher of games and apps in
|
|
||||||
GameShell
|
|
||||||
- [Warehouse](Warehouse "wikilink") - Libraries of browsable and
|
|
||||||
downloadable games, like those developed in [GameShell
|
|
||||||
Jams](GameShell_Jams "wikilink")
|
|
||||||
- [Compatible emulators](Compatible_emulators "wikilink") - NES, SNES,
|
|
||||||
Genesis/MD, PS1, you name it!
|
|
||||||
- [Compatible game engines](Compatible_game_engines "wikilink") -
|
|
||||||
Pygame, LÖVE2D, Pico-8, Tic-80...
|
|
||||||
- [Compatible games](Compatible_games "wikilink") - List of standalone
|
|
||||||
games such as CaveStory, ChocoDM.
|
|
||||||
|
|
||||||
## DevTerm
|
|
||||||
|
|
||||||
### What is DevTerm?
|
|
||||||
|
|
||||||
Devterm is an open source portable terminal for every Dev!
|
|
||||||
|
|
||||||
<figure>
|
|
||||||
<img src="img/DevTerm_fig01.webp" title="DevTerm_fig01.webp" />
|
|
||||||
<figcaption>DevTerm_fig01.webp</figcaption>
|
|
||||||
</figure>
|
|
||||||
|
|
||||||
### Getting started
|
|
||||||
|
|
||||||
[Assembly](Devterm_Assembly "wikilink") - Follow the assembly manual
|
|
||||||
came with DevTerm to assemble the parts.
|
|
||||||
|
|
||||||
[Batteries](Batteries "wikilink") - The 18650 batteries are NOT included
|
|
||||||
in the package due to global logistics complexity for lithium batteries
|
|
||||||
|
|
||||||
### Hardware
|
|
||||||
|
|
||||||
- [Devterm hardware info](Devterm_hardware_info "wikilink") -
|
|
||||||
Information about DevTerm's mainboard, screen, battery, keyboard, and
|
|
||||||
speaker modules
|
|
||||||
- [GPIO](GPIO "wikilink") - Interact with the real world with General
|
|
||||||
Purpose Input/Output lines!
|
|
||||||
- [3D Models](3D_Models "wikilink") - 3D models of DevTerm parts for 3D
|
|
||||||
printing, including community designed custom parts.
|
|
||||||
- [Bluetooth](Bluetooth "wikilink") - Connect other devices using
|
|
||||||
bluetooth
|
|
||||||
- [EXT.](EXT. "wikilink") - Connect devices via the (non-standard)
|
|
||||||
mPCI-E slot
|
|
||||||
- [CORE](CORE "wikilink") - Info about the CORE modules
|
|
||||||
- [Thermal Printer](Thermal_Printer "wikilink") - Print out your .TXT's
|
|
||||||
on the built-in printer!
|
|
||||||
|
|
||||||
### Software
|
|
||||||
|
|
||||||
- [Kernel](Kernel "wikilink") - CPI Linux Kernel
|
|
||||||
- [ClockworkOS](ClockworkOS "wikilink") - The operating system for your
|
|
||||||
DevTerm
|
|
||||||
|
|
||||||
### Howtos
|
|
||||||
|
|
||||||
- [Manjaro on A06](Manjaro_on_A06 "wikilink") - Install Manjaro OS on
|
|
||||||
DevTerm A06
|
|
||||||
- [How-Tos and Tweaks](How-Tos_and_Tweaks "wikilink")
|
|
||||||
|
|
||||||
## Community
|
|
||||||
|
|
||||||
- [Forum](https://forum.clockworkpi.com/)
|
|
||||||
- [Discord](https://discord.gg/XKGGkPM)
|
|
||||||
- [Github](https://github.com/clockworkpi)
|
|
||||||
- [Twitter](https://twitter.com/Hal_clockwork)
|
|
||||||
- [Instagram](https://instagram.com/clockworkpi/)
|
|
||||||
- [GameShell Jams](GameShell_Jams "wikilink")
|
|
||||||
Loading…
x
Reference in New Issue
Block a user