Skip to content

Commit

Permalink
more quick updates - logo, separating the tech docs from the main page
Browse files Browse the repository at this point in the history
  • Loading branch information
ScottKirvan committed Jan 9, 2025
1 parent d6b3eef commit 5f14724
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 44 deletions.
39 changes: 1 addition & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div align="center">

<img src="assets/media/logo.jpg" alt="logo" width="200" height="auto" />
<img src="assets/media/scb_logo.png" alt="logo" width="200" height="auto" />
<h1><a href="https://github.com/SlaughterCountyBrewing/SCBC_RecipeBook">SlaughterCountyBrewing/SCBC_RecipeBook</a></h1>
<h3>Nulla nobis dicta iste minus dolor repellendus aspernatur atque</h3>

Expand Down Expand Up @@ -68,43 +68,6 @@






Branches
--------
`main` is the [deployed](https://www.scottkirvan.com/ScooterGitTemplate/) branch. The repo doesn't currently contain any other historic or dev branches.

Repo Layout
-----------
```
ScooterGitTemplate
├───_layouts
├───.github
│ ├───release-please
│ └───workflows
├───assets
│ ├───css
│ └───media
└───notes
```
The `_layouts` and `assets/css` folders help support the look of the repo when rended to GitHub Pages (Deployment Workflow).
You can see an example of this repo processed using Jekyll and published at [ScottKirvan.com](https://www.scottkirvan.com/ScooterGitTemplate/). You have to enable **Pages** in your repo's settings. Details [here](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll).

The css file creates a page that is styled similar to GitHub's [Dark High Contrast](https://github.blog/changelog/2021-08-25-dark-high-contrast-theme-ga/) theme.

The files in the `.github` folder implement and customizes a github action that runs [Release-Please](https://github.com/googleapis/release-please), which helps with releases, version numbering, and updating the [CHANGELOG](notes/CHANGELOG.md).

>[!NOTE]
> When using this template project, do not clone the tags or branches. Stick with `main` as the name of your main release branch. Change the version number in the `.release-please-manifest.json` file to the version you want to start with.
>
> Release-Please uses [Semantic Versioning](https://semver.org/) (version: MAJOR.MINOR.PATCH). Changes to version numbers are triggered by specific keywords in your commit messages:
> - `feat:` (new feature) will bump the MINOR version number.
> - `fix:` (bug fixes) will bump the PATCH number.
> - `feat!:` `fix!:` or any `xxx!:` (major and breaking changes) will bump the MAJOR version number.


Contributions / Contact
-----------------------
- Please [file an issue](https://github.com/SlaughterCountyBrewing/SCBC_RecipeBook/issues/new), or [grab a fork](https://github.com/SlaughterCountyBrewing/SCBC_RecipeBook/fork), hack away, and submit a [pull request](https://github.com/SlaughterCountyBrewing/SCBC_RecipeBook/pulls).
Expand Down
Binary file added assets/media/scb_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 4 additions & 6 deletions notes/REPO.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<div align="center">

<img src="assets/media/logo.jpg" alt="logo" width="200" height="auto" />
<img src="../assets/media/scb_logo.png" alt="logo" width="200" height="auto" />
<h1><a href="https://github.com/SlaughterCountyBrewing/SCBC_RecipeBook">SlaughterCountyBrewing/SCBC_RecipeBook</a></h1>
<h3>Nulla nobis dicta iste minus dolor repellendus aspernatur atque</h3>
<h3>Technical Repository Notes</h3>


<!-- Badges -->
Expand Down Expand Up @@ -32,8 +32,6 @@
</p>

<h4>
<a href="https://tinyurl.com/3vf7whyd">View Demo</a>
<span> · </span>
<a href="https://github.com/SlaughterCountyBrewing/SCBC_RecipeBook/blob/main/README.md">Documentation</a>
<span> · </span>
<a href="https://github.com/SlaughterCountyBrewing/SCBC_RecipeBook/issues/new?labels=bug&title=%5BBUG%5D">Report Bug</a>
Expand All @@ -42,7 +40,7 @@
</h4>
</div>

**SCBC_Recipebook** is voluptatibus magni nemo est. Nulla nobis dicta iste minus dolor repellendus aspernatur atque. Earum expedita aut inventore tempora fugiat deleniti. Molestias minima nam expedita beatae totam ipsa reprehenderit animi. Occaecati quibusdam beatae ducimus voluptate ut doloribus vitae amet. Quia ut ut voluptate dignissimos adipisci dolorum rem.
**SCBC_Recipebook** was initialized using the [ScooterGitTemplate](https://github.com/ScottKirvan/ScooterGitTemplate), so it automatically includes the structure, functions, and automations outlined below.


Branches
Expand Down Expand Up @@ -85,7 +83,7 @@ Contributions / Contact

Credits
-------
**Copyright (c) (2024):** [Scott Kirvan](https://github.com/ScottKirvan) - All rights reserved
**Copyright (c) (2025):** [Scott Kirvan](https://github.com/ScottKirvan) - All rights reserved
*SCBC_Recipebook is licensed under the [MIT License](LICENSE.md).*

Project Link: [SCBC_Recipebook](https://github.com/SlaughterCountyBrewing/SCBC_RecipeBook)
Expand Down

0 comments on commit 5f14724

Please sign in to comment.