Skip to content

Commit

Permalink
Readme and backyard chicken small update
Browse files Browse the repository at this point in the history
  • Loading branch information
SmailikHappy committed May 2, 2024
1 parent dc1e273 commit f2f0161
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 53 deletions.
58 changes: 6 additions & 52 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,10 @@
# Chirpy Starter
## https://smailikhappy.github.io/

[![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy)][gem] 
[![GitHub license](https://img.shields.io/github/license/cotes2020/chirpy-starter.svg?color=blue)][mit]
This is personal website of Daniel 'SmailikHappy' Smulko.
This repository generates a website on GitHub pages using jekyll workflow.

When installing the [**Chirpy**][chirpy] theme through [RubyGems.org][gem], Jekyll can only read files in the folders
`_data`, `_layouts`, `_includes`, `_sass` and `assets`, as well as a small part of options of the `_config.yml` file
from the theme's gem. If you have ever installed this theme gem, you can use the command
`bundle info --path jekyll-theme-chirpy` to locate these files.
## Credits

The Jekyll team claims that this is to leave the ball in the user’s court, but this also results in users not being
able to enjoy the out-of-the-box experience when using feature-rich themes.
The original theme used on the website is [Chirpy](chirpy).

To fully use all the features of **Chirpy**, you need to copy the other critical files from the theme's gem to your
Jekyll site. The following is a list of targets:

```shell
.
├── _config.yml
├── _plugins
├── _tabs
└── index.html
```

To save you time, and also in case you lose some files while copying, we extract those files/configurations of the
latest version of the **Chirpy** theme and the [CD][CD] workflow to here, so that you can start writing in minutes.

## Prerequisites

Follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of
the basic environment. [Git](https://git-scm.com/) also needs to be installed.

## Installation

Sign in to GitHub and [**use this template**][use-template] to generate a brand new repository and name it
`USERNAME.github.io`, where `USERNAME` represents your GitHub username.

Then clone it to your local machine and run:

```console
$ bundle
```

## Usage

Please see the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy#documentation).

## License

This work is published under [MIT][mit] License.

[gem]: https://rubygems.org/gems/jekyll-theme-chirpy
[chirpy]: https://github.com/cotes2020/jekyll-theme-chirpy/
[use-template]: https://github.com/cotes2020/chirpy-starter/generate
[CD]: https://en.wikipedia.org/wiki/Continuous_deployment
[mit]: https://github.com/cotes2020/chirpy-starter/blob/master/LICENSE
[chirpy]: https://chirpy.cotes.page/
5 changes: 4 additions & 1 deletion _posts/2023-06-23-Backyard_chickens.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
---
title: "Backyard chickens"
categories: [Group projects]
image:
path: assets/post_data/backyard_chickens/logo.png
---

## General information

This is a group project completed at university as part of a course assignment. The team consisted of 14 developers.\
The game is a remake of [Rampart](https://en.wikipedia.org/wiki/Rampart_(video_game)) from 1990, featuring a chicken-themed style. It was developed using Unreal Engine.

The game can be found on [itch.io](https://smooth-dedede.itch.io/backyardchickens)
> The game can be found on [itch.io](https://smooth-dedede.itch.io/backyardchickens)
{: .prompt-tip}

## Personal contribution

Expand Down
Binary file added assets/post_data/backyard_chickens/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f2f0161

Please sign in to comment.