Skip to content
This repository has been archived by the owner on Sep 28, 2019. It is now read-only.

Commit

Permalink
README: update links
Browse files Browse the repository at this point in the history
  • Loading branch information
ilg-ul committed Jan 18, 2019
1 parent 3875fd5 commit dd1d901
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 12 deletions.
31 changes: 22 additions & 9 deletions .github/ISSUE_TEMPLATE
Original file line number Diff line number Diff line change
@@ -1,23 +1,33 @@

### Prerequisites

In case you encounter problems while using the **GNU MCU Eclipse OpenOCD**, please consider the following:
In case you encounter problems while using the **GNU MCU Eclipse OpenOCD**,
please consider the following:

* [ ] read the documentation pages carefully
* [ ] check the [Known issues](http://gnuarmeclipse.github.io/support/known-issues/)
* [ ] check the [FAQ](http://gnuarmeclipse.github.io/support/faq/)
* [ ] check the [GNU ARM Eclipse forum](http://gnuarmeclipse.github.io/support/forum/) for similar problems
* [ ] check the GitHub Issues [tracker](https://github.com/gnuarmeclipse/openocd/issues/)

If you still could not find a solution, if you have interesting use cases, if you have custom
configurations, and generally if you have any experience that you want to share with others,
If you still could not find a solution, if you have interesting use cases,
if you have custom
configurations, and generally if you have any experience that you want to
share with others,
use the [GNU ARM Eclipse forum](http://gnuarmeclipse.github.io/support/forum/).

Just [register](http://www.element14.com/community/create-account.jspa) to element14 community and use the [Start a discussion](http://www.element14.com/community/discussion/create.jspa?containerID=2436&containerType=700) link, with the OpenOCD category.
Just [register](http://www.element14.com/community/create-account.jspa)
to element14 community and use the
[Start a discussion](http://www.element14.com/community/discussion/create.jspa?containerID=2436&containerType=700)
link, with the OpenOCD category.

If you are convinced that you identified a bug (if you have doubts, use the forum), or you have a
pertinent suggestion how to enhance GNU MCU Eclipse OpenOCD, continue and register
an issue, but please keep in mind that GNU MCU Eclipse OpenOCD only repacks the binaries, without significant changes, and functional changes should normally be addressed to the original project developers.
If you are convinced that you identified a bug (if you have doubts, use
the forum), or you have a
pertinent suggestion how to enhance GNU MCU Eclipse OpenOCD, continue
and register
an issue, but please keep in mind that GNU MCU Eclipse OpenOCD **only
repacks the binaries, without significant changes, and functional
changes should normally be addressed to the original project developers**.

### Description

Expand All @@ -43,11 +53,14 @@ an issue, but please keep in mind that GNU MCU Eclipse OpenOCD only repacks the
* toolchain version
* the **detailed and complete list of steps to reproduce the bug** (mandatory)

Please understand that without being able to reproduce the bug we cannot identify your problem.
Please understand that without being able to reproduce the bug we cannot
identify your problem.

To be allowed to enter issues, you need first to login to GitHub.

Note: the text should respect the markdown syntax; preview the message before posting and correct if it does not look as expected, especially inline code or other quoted text.
Note: the text should respect the markdown syntax; preview the message
before posting and correct if it does not look as expected, especially
inline code or other quoted text.

---

Expand Down
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@ Expect **GNU MCU Eclipse OpenOCD** to follow official OpenOCD releases, plus sev

## RISC-V support

The **GNU MCU Eclipse OpenOCD** also tracks the changes from the [RISC-V OpenOCD](https://github.com/riscv/riscv-openocd) fork.
After RISC-V support was upstreamed, **GNU MCU Eclipse OpenOCD** no longer
tracks the changes from the
[RISC-V OpenOCD](https://github.com/riscv/riscv-openocd) fork, since
some of them interfered with other targets.

## How to use

Expand All @@ -17,8 +20,9 @@ The **GNU MCU Eclipse OpenOCD** also tracks the changes from the [RISC-V OpenOCD

## How to build

* [How to build](https://gnu-mcu-eclipse.github.io/openocd/build-procedure/) (using Docker containers)
* [Change log](https://gnu-mcu-eclipse.github.io/openocd/change-log/)
* [How to build](https://github.com/gnu-mcu-eclipse/openocd-build/) (using Docker containers)
* [How to publish](https://github.com/gnu-mcu-eclipse/openocd/blob/gnu-mcu-eclipse-dev/PUBLISH.md)
* [Change log](https://github.com/gnu-mcu-eclipse/openocd-build/blob/master/CHANGELOG.txt)

## Releases & binaries

Expand Down

0 comments on commit dd1d901

Please sign in to comment.