First commit

.circleci/config.yml

@@ -0,0 +1,20 @@
+# Java Gradle CircleCI 2.0 configuration file
+version: 2
+jobs:
+  build:
+    branches:
+      only:
+        - develop
+        - master
+    docker:
+      - image: maciejmalecki/c64libci:0.1.4
+
+    working_directory: ~/repo
+
+    environment:
+      JVM_OPTS: -Xms256m -Xmx768m
+      TERM: dumb
+
+    steps:
+      - checkout
+      - run: ./gradlew

.github/workflows/main.yml

@@ -0,0 +1,42 @@
+name: Doxygen Action
+
+# Controls when the action will run. Triggers the workflow on push or pull request
+# events but only for the master branch
+on:
+  push:
+    branches: [ master ]
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+    # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+    - uses: actions/checkout@v2
+
+    - name: Convert doxygen liked version
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10' 
+    - run:
+        python KickAssemblerToDoxygen.py ./lib/
+
+    - name: Doxygen Action
+      uses: mattnotmitt/[email protected]
+      with:
+        # Path to Doxyfile
+        doxyfile-path: "./Doxyfile"
+        # Working directory
+        working-directory: "."
+
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        # Default Doxyfile build documentation to html directory. 
+        # Change the directory if changes in Doxyfile
+        publish_dir: ./html

.gitignore

@@ -0,0 +1,21 @@
+# KickAssembler out files
+*.prg
+*.sym
+*.dbg
+*.vs
+*.specOut
+.asminfo.txt
+.source.txt
+
+# Gradle files
+.gradle
+
+# Doxygen
+html/*
+xml/*
+lib/output
+
+# IDE and tool files
+.idea
+.ra
+.vscode

CONTRIBUTING.md

@@ -0,0 +1,41 @@
+# Welcome to contributing guide
+TBD
+## Guide to contributing code
+TBD
+
+## Guide to contributing documentation
+### File header
+TBD
+
+### Subroutine and macro header
+Every subroutine and macro should have an header like this:
+
+<pre>
+/**
+ * @brief This macro copies a block of memory from one location to another using page relocation.
+ * 
+ * @details This macro also handles the page relocation of the memory block during the copy operation.
+ * It's slower than @sa copyFast but it uses much less memory, especially for large memory blocks copy.
+ *
+ * @param[in] source The starting address of the memory block to be copied.
+ * @param[in] destination The starting address of the location where the memory block will be copied to.
+ * @param[in] count The number of bytes to be copied.
+ *
+ * @note Usage: copyWithRelocation($C000, $C100, 256)  // Copies 256 bytes from memory location $C000 to $C100 with relocation
+ * @note Use c128lib_copyWithRelocation in mem-global.asm
+ *
+ * @since 0.6.0
+ */
+</pre>
+
+* a @brief keyword with a short description (typically one or two line)
+* a @details keyword (optional) with a longer description, with some hint about code used and comparison with similar code
+* a @param keyword for every parameter, with [in], [out] or [in,out] attribute to specify if parameter is an input
+or output value
+* a @remark keyword for indicating if registers or flags are affrected
+* a @note keyword for "non-global" macros to suggest to use global macro definition
+* a @since keyword to specify from which version this code is available
+
+#### Other keywords under evaluation
+* a @example keyword (optional) for pointing to other source code where method is used
+* a @note keyword (optional) for a simple usage code