deprecate robotpy-cppheaderparser

virtuald · virtuald · commit cc3967e18926 · 2023-10-05T03:26:58.000-04:00
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -0,0 +1,25 @@
+name: Bug Report
+description: |
+  Please be aware that we are no longer making fixes ourselves
+  to robotpy-cppheaderparser, but we will accept pull requests with appropriately
+  tested fixes. We recommend all users migrate to our new parser which can be
+  found at https://github.com/robotpy/cxxheaderparser
+title: "[BUG]: "
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Problem description
+      placeholder: >-
+        Provide a short description, state the expected behavior and what
+        actually happens.
+    validations:
+      required: true
+
+  - type: textarea
+    id: code
+    attributes:
+      label: Reproducible example code
+      placeholder: >-
+        Minimal code to reproduce this issue
+      render: text
diff --git a/README.rst b/README.rst
@@ -1,7 +1,17 @@
 robotpy-cppheaderparser
 =======================
 
-|Build Status|
+**robotpy-cppheaderparser is DEPRECATED, and we are no longer updating it**.
+We will accept pull requests that have fixes and appropriate tests, but we
+will no longer be making any fixes ourselves.
+
+We highly recommend all current and future users to migrate to cxxheaderparser,
+which supports all the syntax that CppHeaderParser does and much much more. The
+parser output is very different, but it is strictly typed and hopefully easier
+to work with. You can find it at https://github.com/robotpy/cxxheaderparser,
+or try the live interactive demo at https://robotpy.github.io/cxxheaderparser/
+
+---------
 
 CppHeaderParser is a pure python C++ header parser that parses C++
 headers and creates a data structure that you can use to do many types
@@ -62,6 +72,3 @@ Past contributors include:
 .. _CppHeaderParser: https://bitbucket.org/senex/cppheaderparser
 
 .. _pcpp: https://github.com/ned14/pcpp
-
-.. |Build Status| image:: https://travis-ci.org/robotpy/robotpy-cppheaderparser.svg?branch=master
-   :target: https://travis-ci.org/robotpy/robotpy-cppheaderparser
