Merge pull request #800 from Ralim/cleanup-source-folder

Cleanup the source folder location

.github/workflows/push.yml

@@ -1,6 +1,6 @@
 name: CI
 
-on: [push,pull_request]
+on: [push, pull_request]
 
 jobs:
   build_TS80:
@@ -10,8 +10,8 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: chmod
-        run: chmod +x setup.sh && chmod +x workspace/TS100/build.sh && sudo mkdir -p /build/cache && sudo chmod -R 777 /build
-      
+        run: chmod +x setup.sh && chmod +x source/build.sh && sudo mkdir -p /build/cache && sudo chmod -R 777 /build
+
       - name: Cached compiler source files
         uses: actions/cache@v2
         env:
@@ -27,15 +27,15 @@ jobs:
         run: ./setup.sh
 
       - name: build TS80
-        run: cd workspace/TS100 && ./build.sh -m TS80
+        run: cd source && ./build.sh -m TS80
 
       - name: Archive TS80 artifacts
         uses: actions/upload-artifact@v2
         with:
           name: TS80
           path: |
-            workspace/TS100/Hexfile/TS80_*.hex
-            workspace/TS100/Hexfile/TS80_*.bin
+            source/Hexfile/TS80_*.hex
+            source/Hexfile/TS80_*.bin
           if-no-files-found: error
   build_TS80P:
     runs-on: ubuntu-latest
@@ -44,7 +44,7 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: chmod
-        run: chmod +x setup.sh && chmod +x workspace/TS100/build.sh && sudo mkdir -p /build/cache && sudo chmod -R 777 /build
+        run: chmod +x setup.sh && chmod +x source/build.sh && sudo mkdir -p /build/cache && sudo chmod -R 777 /build
 
       - name: Cached compiler source files
         uses: actions/cache@v2
@@ -61,15 +61,15 @@ jobs:
         run: ./setup.sh
 
       - name: build TS80P
-        run: cd workspace/TS100 && ./build.sh -m TS80P
+        run: cd source && ./build.sh -m TS80P
 
       - name: Archive TS80P artifacts
         uses: actions/upload-artifact@v2
         with:
           name: TS80P
           path: |
-            workspace/TS100/Hexfile/TS80P_*.hex
-            workspace/TS100/Hexfile/TS80P_*.bin
+            source/Hexfile/TS80P_*.hex
+            source/Hexfile/TS80P_*.bin
           if-no-files-found: error
   build_TS100:
     runs-on: ubuntu-latest
@@ -78,8 +78,8 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: chmod
-        run: chmod +x setup.sh && chmod +x workspace/TS100/build.sh && sudo mkdir -p /build/cache && sudo chmod -R 777 /build
-        
+        run: chmod +x setup.sh && chmod +x source/build.sh && sudo mkdir -p /build/cache && sudo chmod -R 777 /build
+
       - name: Cached compiler source files
         uses: actions/cache@v2
         env:
@@ -95,15 +95,15 @@ jobs:
         run: ./setup.sh
 
       - name: build TS100
-        run: cd workspace/TS100 && ./build.sh -m TS100
+        run: cd source && ./build.sh -m TS100
 
       - name: Archive TS100 artifacts
         uses: actions/upload-artifact@v2
         with:
           name: TS100
           path: |
-            workspace/TS100/Hexfile/TS100_*.hex
-            workspace/TS100/Hexfile/TS100_*.bin
+            source/Hexfile/TS100_*.hex
+            source/Hexfile/TS100_*.bin
           if-no-files-found: error
 
   build_Pinecil:
@@ -113,8 +113,8 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: chmod
-        run: chmod +x setup.sh && chmod +x workspace/TS100/build.sh && sudo mkdir -p /build/cache && sudo chmod -R 777 /build
-        
+        run: chmod +x setup.sh && chmod +x source/build.sh && sudo mkdir -p /build/cache && sudo chmod -R 777 /build
+
       - name: Cached compiler source files
         uses: actions/cache@v2
         env:
@@ -130,13 +130,13 @@ jobs:
         run: ./setup.sh
 
       - name: build Pinecil
-        run: cd workspace/TS100 && ./build.sh -m Pinecil
+        run: cd source && ./build.sh -m Pinecil
 
       - name: Archive Pinecil artifacts
         uses: actions/upload-artifact@v2
         with:
           name: Pinecil
           path: |
-            workspace/TS100/Hexfile/Pinecil_*.hex
-            workspace/TS100/Hexfile/Pinecil_*.bin
+            source/Hexfile/Pinecil_*.hex
+            source/Hexfile/Pinecil_*.bin
           if-no-files-found: error

.gitignore

@@ -27,46 +27,33 @@
 *.app
 *.i*86
 *.x86_64
-workspace/*.hex
 
 # Debug files
 *.dSYM/
 *.su
-workspace/ts100/Debug/*
-workspace/.metadata/*
+source/.metadata/*
 
-workspace/ts100/.settings/language.settings.xml
-workspace/ts100/.cproject
 TS100/KiCad/TS100.bak
 Logo GUI/TS100 Logo Editor/TS100 Logo Editor/obj/
 Logo GUI/TS100 Logo Editor/TS100 Logo Editor/bin/
-workspace/ts100/ts100.xml
-workspace/ts100_old/*
 *.cache
-workspace/TS100/.settings/language.settings.xml
-workspace/TS100A/Release/TS100A.map
-workspace/TS100A/Release/TS100A.list
-workspace/TS100A/Release/TS100A.hex
-workspace/TS100A/.settings/language.settings.xml
-workspace/TS100A/.metadata/
 Translation Editor/.vscode/
 Translation Editor/__pycache__/
 *.pyc
 *.lst
 *.mk
 *.list
-workspace/TS100/Release/
-workspace/TS100/Hexfile/
-workspace/RemoteSystemsTempFiles/
-workspace/TS100/.settings/
-workspace/TS100/TS80/
+source/Hexfile/
+source/Objects/
+
 ci/artefacts/
 ci/secrets/unencrypted/
 codeship.aes
 .vscode/settings.json
 
 # Auto generated files
-workspace/TS100/Core/Inc/unit.h
+source/Core/Inc/unit.h
+source/Core/Gen/
 # IDE configs
 .vs/*
 .settings/*
@@ -189,4 +176,3 @@ fabric.properties
 
 CoreCompileInputs.cache
 .vscode/settings.json
-workspace/TS100/TS100/

Documentation/Development.md

@@ -4,11 +4,14 @@ Building this software can be performed two ways, using the STMCubeIDE or using
 
 ## STM Cube IDE
 
-The repository is setup to try and make this painless, when starting the IDE you can import the project by pointing the internal search to the workspace folder of this repository. If you start with a fresh installation, close the welcome screen tab, and then in the left sidebar, there is an option to "import". Select General -> Import existing projects -> Set the top location option to this repositories workspace -> Should find the TS100 project.
+The easiest way to start working using the STM Cube IDE is to create a new project for the STM32F103RCTx.
+Then once this is created remove the auto-generated source code.
+Next drag the contents of the `source` folder into the project and choose to link to files.
+You will need to update the build settings for include paths & point to the new `.ld` linker file
 
 ## Developing with command line tools & building a release
 
-In the `workspace/TS100` folder there is a makefile that can be used to build the repository using command line tools.
+In the `source` folder there is a makefile that can be used to build the repository using command line tools.
 when running the `make` command, specify which model of the device & the language you would like to use.
 
 `make -j8 lang=EN model=TS80`
@@ -23,4 +26,5 @@ To update the language translation files & associated font map, execute the `mak
 
 I highly reccomend using the command line tools and using docker to run the compiler.
 Its a bit more fussy on setup than the STM tooling and this is by far the easiest way.
-If you _need_ an IDE I have used [Nuclei's IDE](https://nucleisys.com/download.php)
+If you _need_ an IDE I have used [Nuclei's IDE](https://nucleisys.com/download.php)
+And follow same idea as the STM Cube IDE notes above.

Translations/make_translation.py

@@ -509,9 +509,7 @@ def writeUnit(languageCode, defs, f, UnitCodes):
 
 
 def readVersion():
-    with open(
-        os.path.relpath(jsonDir + "/../workspace/TS100/version.h"), "r"
-    ) as version_file:
+    with open(os.path.relpath(jsonDir + "/../source/version.h"), "r") as version_file:
         try:
             for line in version_file:
                 if re.findall(r"^.*(?<=(#define)).*(?<=(BUILD_VERSION))", line):
@@ -551,13 +549,15 @@ def read_opts():
     if len(sys.argv) > 2:
         outFileTranslationCPP = sys.argv[2]
     else:
-        outDir = os.path.relpath(jsonDir + "/../workspace/TS100/Core/Gen")
+        outDir = os.path.relpath(jsonDir + "/../source/Core/Gen")
+        if not os.path.exists(outDir):
+            os.makedirs(outDir)
         outFileTranslationCPP = os.path.join(outDir, TRANSLATION_CPP)
 
     if len(sys.argv) > 3:
         outFileUnitH = sys.argv[3]
     else:
-        outDir = os.path.relpath(jsonDir + "/../workspace/TS100/Core/Inc")
+        outDir = os.path.relpath(jsonDir + "/../source/Core/Inc")
         outFileUnitH = os.path.join(outDir, UNIT_H)
 
     if len(sys.argv) > 4:

ci/buildAll.sh

@@ -5,9 +5,9 @@ set -u
 mkdir -p /build/ci/artefacts
 
 # Build STM code
-cd /build/source/workspace/TS100/
+cd /build/source/source/
 bash ./build.sh || exit 1
 echo "All Firmware built"
 # Copy out all the final resulting files we would like to store for the next op
-cp -r /build/source/workspace/TS100/Hexfile/*.hex  /build/ci/artefacts/
-cp -r /build/source/workspace/TS100/Hexfile/*.bin  /build/ci/artefacts/
+cp -r /build/source/source/Hexfile/*.hex  /build/ci/artefacts/
+cp -r /build/source/source/Hexfile/*.bin  /build/ci/artefacts/