[gnome-bootstrap-theme] docs: update README to give instructions on how to build the theme
- From: Guillaume Bernard <gbernard src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-bootstrap-theme] docs: update README to give instructions on how to build the theme
- Date: Sun, 25 Sep 2022 13:25:05 +0000 (UTC)
commit b357c5e1b8791d4ce188e3610aaae7b8542248ee
Author: Guillaume Bernard <associations guillaume-bernard fr>
Date: Sun Sep 25 15:24:59 2022 +0200
docs: update README to give instructions on how to build the theme
README.md | 27 +++++++++++++--------------
build_theme.sh => build_deneb_theme.sh | 0
2 files changed, 13 insertions(+), 14 deletions(-)
---
diff --git a/README.md b/README.md
index 02d0d7e..d7fc172 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,19 @@
# GNOME Deneb
+
Bootstrap theme for GNOME websites
-## Get started
-Requirements:
-NPM package
+## Compile the Deneb theme
-#### Running the project:
-* Clone the repo
-* Install NPM dependencies
-
- ```
+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.
+
+To retrieve the necessary dependencies, run:
+ ```bash
npm install
```
- * Run the project
-
- ```
- npm start
- ```
- Visit local webserver http://localhost:8000/ to see or edit the created theme.
+
+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.
+
+## Dependencies and Licence Issues
+
+* [`bootstrap`](https://getbootstrap.com/docs/5.2) is released under the [**MIT
LICENSE**](https://github.com/twbs/bootstrap/blob/main/LICENSE).
+* [`fontawesome`](https://fontawesome.com) is released under a [**free
license**](https://github.com/FortAwesome/Font-Awesome/blob/6.x/LICENSE.txt). We use the free package of this
project.
\ No newline at end of file
diff --git a/build_theme.sh b/build_deneb_theme.sh
similarity index 100%
rename from build_theme.sh
rename to build_deneb_theme.sh
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]