Initial commit

Author: ejpcmac

.cargo/config

@@ -0,0 +1,6 @@
+[target.'cfg(all(target_arch = "arm", target_os = "none"))']
+rustflags = ["-C", "link-arg=-Tlink.x"]
+runner = "arm-none-eabi-gdb -q -x openocd.gdb"
+
+[build]
+target = "thumbv7em-none-eabihf" # Cortex-M4+ / Cortex-M7+

.editorconfig

@@ -0,0 +1,18 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+max_line_length = 80
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.nix]
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false

.envrc

@@ -0,0 +1 @@
+use nix

.gitignore

@@ -0,0 +1,16 @@
+##
+## Application artifacts
+##
+
+# direnv cache for Nix shells
+/.direnv/
+
+# Rust build directory
+/target/
+
+##
+## Editor artifacts
+##
+
+/.history/
+/.vscode/.cortex-debug.*

.gitsetup

@@ -0,0 +1,11 @@
+#!/bin/sh
+
+set -e
+set -x
+
+# Setup git-flow
+git flow init -d
+git config gitflow.prefix.versiontag "v"
+git config gitflow.feature.finish.no-ff true
+git config gitflow.release.finish.sign true
+git config gitflow.hotfix.finish.sign true

.vscode/launch.json

@@ -0,0 +1,20 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "STM32L4 Debug",
+            "cwd": "${workspaceRoot}",
+            "executable": "./target/thumbv7em-none-eabihf/debug/ercp_basic_example",
+            "type": "cortex-debug",
+            "request": "launch",
+            "servertype": "openocd",
+            "configFiles": [
+                "openocd.cfg"
+            ],
+            "preLaunchTask": "rust: cargo build",
+            "preLaunchCommands": [
+                "load"
+            ]
+        }
+    ]
+}

CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic
+Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+* Initial version
+
+[Unreleased]: https://github.com/ercp/ercp_basic_example/compare/main...develop

CONTRIBUTING.md

@@ -0,0 +1,102 @@
+# Contributing to ercp_basic_example
+
+ercp_basic_example is written in [Rust](https://www.rust-lang.org/).
+
+For branching management, this project uses
+[git-flow](https://github.com/petervanderdoes/gitflow-avh). The `main` branch is
+reserved for releases: the development process occurs on `develop` and feature
+branches. **Please never commit to master.**
+
+## Setup
+
+### Local repository
+
+1. Fork the repository
+
+2. Clone your fork to a local repository:
+
+        $ git clone https://github.com/you/ercp_basic_example.git
+        $ cd ercp_basic_example
+
+3. Add the main repository as a remote:
+
+        $ git remote add upstream https://github.com/ercp/ercp_basic_example.git
+
+4. Checkout to `develop`:
+
+        $ git checkout develop
+
+### Building the project
+
+1. Build the project:
+
+        $ cd ercp_basic_example
+        $ cargo build
+
+2. Run the tests:
+
+        $ cargo test
+
+All the tests should pass.
+
+## Workflow
+
+To make a change, please use this workflow:
+
+1. Checkout to `develop` and apply the last upstream changes (use rebase, not
+    merge!):
+
+        $ git checkout develop
+        $ git fetch --all --prune
+        $ git rebase upstream/develop
+
+2. For a tiny patch, create a new branch with an explicit name:
+
+        $ git checkout -b <my_branch>
+
+    Alternatively, if you are working on a feature which would need more work,
+    you can create a feature branch with `git-flow`:
+
+        $ git flow feature start <my_feature>
+
+    *Note: always open an issue and ask before starting a big feature, to avoid
+    it not beeing merged and your time lost.*
+
+3. Work on your feature (don’t forget to write tests):
+
+        # Some work
+        $ git commit -am "My first change"
+        # Some work
+        $ git commit -am "My second change"
+        ...
+
+4. When your feature is ready, feel free to use
+    [interactive rebase](https://help.github.com/articles/about-git-rebase/) so
+    your history looks clean and is easy to follow. Then, apply the last
+    upstream changes on `develop` to prepare integration:
+
+        $ git checkout develop
+        $ git fetch --all --prune
+        $ git rebase upstream/develop
+
+5. If there were commits on `develop` since the beginning of your feature
+    branch, integrate them by **rebasing** if your branch has few commits, or
+    merging if you had a long-lived branch:
+
+        $ git checkout <my_feature_branch>
+        $ git rebase develop
+
+    *Note: the only case you should merge is when you are working on a big
+    feature. If it is the case, we should have discussed this before as stated
+    above.*
+
+6. Run the tests to ensure there is no regression and all works as expected:
+
+        $ cargo test
+
+7. If it’s all good, open a pull request to merge your branch into the `develop`
+    branch on the main repository.
+
+## Coding style
+
+Please format your code with `rustfmt`.