Root directory content refactoring

.github/workflows/docs.yml

@@ -37,4 +37,4 @@ jobs:
       - run: git config user.name 'github-actions[bot]' && git config user.email 'github-actions[bot]@users.noreply.github.com'
 
       - name: Publish docs
-        run: mkdocs gh-deploy
+        run: mkdocs gh-deploy -f scripts/IronOS-mkdocs.yml -d ../site

.github/workflows/push.yml

@@ -32,7 +32,7 @@ jobs:
       - name: copy license text
         run: |
           cp LICENSE source/Hexfile/LICENSE
-          cp LICENSE_RELEASE.md source/Hexfile/LICENSE_RELEASE.md
+          cp scripts/LICENSE_RELEASE.md source/Hexfile/LICENSE_RELEASE.md
 
       - name: Archive ${{ matrix.model }} artifacts
         uses: actions/upload-artifact@v3
@@ -83,7 +83,7 @@ jobs:
       - name: copy license text
         run: |
           cp LICENSE source/Hexfile/LICENSE
-          cp LICENSE_RELEASE.md source/Hexfile/LICENSE_RELEASE.md
+          cp scripts/LICENSE_RELEASE.md source/Hexfile/LICENSE_RELEASE.md
 
       - name: Archive ${{ matrix.model }} artifacts
         uses: actions/upload-artifact@v3

Documentation/Flashing/MHP30.md

@@ -55,7 +55,7 @@ sgr1ff1n (Shane) commented in [issue 11](https://github.com/Ralim/IronOS/issues/
 
 While in the past there were reports of unreliable upgrades, the consensus in [issue 11](https://github.com/Ralim/IronOS/issues/11) is that things work mostly as expected in Linux.
 
-@awigen has contributed a script [flash_ts100_linux.sh](https://raw.githubusercontent.com/Ralim/IronOS/master/Flashing/flash_ts100_linux.sh) that works on Ubuntu 16.04 as well as other distros.
+@awigen has contributed a script [flash_ts100_linux.sh](https://raw.githubusercontent.com/Ralim/IronOS/dev/scripts/flash_ts100_linux.sh) that works on Ubuntu 16.04 as well as other distros.
 
 If you want to do it manually (or if the script does not work for some reason) the general procedure is the same as for Windows, the differences are in the way to mount the unit and copy the firmware.
 Remember that after flashing, the firmware filename will have changed to end in `.RDY` or `.ERR` or `.NOT` and only `.RDY` means the flashing was successful!

Documentation/Flashing/TS100.md

@@ -55,7 +55,7 @@ sgr1ff1n (Shane) commented in [issue 11](https://github.com/Ralim/IronOS/issues/
 
 While in the past there were reports of unreliable upgrades, the consensus in [issue 11](https://github.com/Ralim/IronOS/issues/11) is that things work mostly as expected in Linux.
 
-@awigen has contributed a script [flash_ts100_linux.sh](https://raw.githubusercontent.com/Ralim/IronOS/master/Flashing/flash_ts100_linux.sh) that works on Ubuntu 16.04 as well as other distros.
+@awigen has contributed a script [flash_ts100_linux.sh](https://raw.githubusercontent.com/Ralim/IronOS/dev/scripts/flash_ts100_linux.sh) that works on Ubuntu 16.04 as well as other distros.
 
 If you want to do it manually (or if the script does not work for some reason) the general procedure is the same as for Windows, the differences are in the way to mount the unit and copy the firmware.
 Remember that after flashing, the firmware filename will have changed to end in `.RDY` or `.ERR` or `.NOT` and only `.RDY` means the flashing was successful!

docker-compose.yml → IronOS.yml

@@ -6,7 +6,8 @@ services:
     tty: true
     build:
       context: .
+      dockerfile: Scripts/IronOS.Dockerfile
     command: /bin/sh
     volumes:
-      - ./ci:/build/ci:Z
+      - ./scripts/ci:/build/ci:Z
       - ./:/build/source:Z

Makefile

@@ -0,0 +1,62 @@
+#!/usr/bin/env make
+# Root Makefile for IronOS - Soldering Iron Open Source Firmware Project
+
+
+### global adjustable variables
+
+# command for docker-compose tool
+ifndef DOCKER_COMPOSE
+DOCKER_COMPOSE:=docker-compose
+endif
+
+# command for python-based mkdocs tool
+ifndef MKDOCS
+MKDOCS:=mkdocs
+endif
+
+
+### global static variables
+
+# docker-related files
+DOCKER_YML=$(CURDIR)/IronOS.yml
+DOCKER_FILE=$(CURDIR)/scripts/IronOS.Dockerfile
+
+# docker dependencies
+DOCKER_DEPS=$(DOCKER_YML) $(DOCKER_FILE)
+
+# compose docker-compose command
+DOCKER_CMD=$(DOCKER_COMPOSE)  -f $(DOCKER_YML)  run  --rm  builder
+
+# MkDocs config
+MKDOCS_YML=$(CURDIR)/scripts/IronOS-mkdocs.yml
+
+
+### helper targets
+
+# former start_dev.sh
+docker-shell: $(DOCKER_DEPS)
+	@$(DOCKER_CMD)
+
+# former build.sh
+docker-build: $(DOCKER_DEPS)
+	@$(DOCKER_CMD)  /bin/bash  /build/ci/buildAll.sh
+
+# delete container
+docker-clean:
+	-@docker  rmi  ironos-builder:latest
+
+# generate docs in site/ directory (DIR for -d is relative to mkdocs.yml file location, hence use default name/location site by setting up ../site)
+docs: $(MKDOCS_YML)  Documentation/*  Documentation/Flashing/*  Documentation/images/*
+	@$(MKDOCS)  build  -f $(MKDOCS_YML)  -d ../site
+
+# pass-through target for Makefile inside source/ dir
+%:
+	make  -C source/  $@
+
+# global clean-up target
+clean-full: docker-clean
+	make  -C source/  clean-all
+	rm  -Rf  site
+	rm  -Rf  scripts/ci/artefacts
+
+.PHONY:  docker-shell  docker-build  docker-clean  docs  clean-full

README.md

@@ -70,6 +70,9 @@ For notes on installation for your device, please refer to the flashing guide fo
 - [Custom boot up logo support](https://ralim.github.io/IronOS/Logo/)
 - Automatic LCD rotation based on the orientation
 
+**Bootup Logo NOTICE**:
+IronOS supports both a bootup logo _AND_ bootup animations. However, _they are no longer included in this repo_. Please, [read the docs](https://ralim.github.io/IronOS/Logo/) for more information.
+
 ## Menu System
 
 This new firmware uses a new menu system to allow access to the settings on the device.

mkdocs.yml → scripts/IronOS-mkdocs.yml

@@ -6,7 +6,7 @@ site_description: "IronOS Open Source Soldering Iron firmware for Miniware and P
 # repo config
 repo_url: https://github.com/ralim/IronOS/
 
-docs_dir: Documentation
+docs_dir: ../Documentation
 edit_uri: edit/dev/Documentation/
 
 # Theme and config

Dockerfile → scripts/IronOS.Dockerfile

@@ -26,4 +26,4 @@ RUN python3 -m pip install ${PIP_PKGS}
 RUN git config --global --add safe.directory /build/source
 
 COPY . /build/source
-COPY ./ci /build/ci
+COPY ./Scripts/ci /build/ci