[gnome-bootstrap-theme] docs: update README with updated instructions
- From: Guillaume Bernard <gbernard src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-bootstrap-theme] docs: update README with updated instructions
- Date: Mon, 26 Sep 2022 11:33:05 +0000 (UTC)
commit f761b78c45704088ad4e12e8194db8409519318c
Author: Guillaume Bernard <associations guillaume-bernard fr>
Date: Mon Sep 26 13:33:01 2022 +0200
docs: update README with updated instructions
LICENSE | 1 +
README.md | 14 +++++++++++---
2 files changed, 12 insertions(+), 3 deletions(-)
---
diff --git a/LICENSE b/LICENSE
index c366bfb..9a01dba 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,4 +1,5 @@
Copyright 2017-2018 Tom Tryfonidis <tomtryf gnome org>
+Copyright 2022 Guillaume Bernard <associations guillaume-bernard fr>
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is
hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
diff --git a/README.md b/README.md
index d7fc172..8fe7cd0 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,25 @@
# GNOME Deneb
-Bootstrap theme for GNOME websites
+[Bootstrap](https://getbootstrap.com/) theme for GNOME websites.
## Compile the Deneb theme
-In order to build this theme, you need to install `npm` in order to retrieve the dependencies (`bootstrap`
and `fontawesome`) used to build the CSS/JS/Fonts files. To compile SCSS stylesheets, it uses the `sass`
command line program and `uglifyjs` to compress the JS files.
+In order to build this theme, you need to install `npm` in order to retrieve the dependencies (`bootstrap`
and `fontawesome`) used to build the CSS/JS/Fonts files. To compile SCSS stylesheets, it uses the `sassc`
command line program and `uglifyjs` to compress the JS files.
+
+On Fedora, packages are called `sassc`, `uglify-js` and `npm`, as in Alpine Linux (used in the CI process).
To retrieve the necessary dependencies, run:
```bash
npm install
```
-And then, if all the other dependencies are installed on your system, you can run the `build_deneb_theme.sh`
shell script. All the theme files will be stored in the `dist` directory.
+This will download both Bootstrap and Font-Awesome SCSS files. Then, if all the other dependencies are
installed on your system, you can run the `build_deneb_theme.sh` shell script. All the theme files will be
stored in the `dist` directory.
+
+This includes:
+
+ * The full `bootstrap` css classes and features
+ * A GNOME specific theme (with adapted colors and classes). An example is shown in the `index.html` file.
+ * Icons provided by the `fontawesome` project. It is used to include some action icons for instance.
## Dependencies and Licence Issues
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]