From 6eb8b13f6ecbee000033bff649e8405f84f68b5c Mon Sep 17 00:00:00 2001 From: Fan Jiang Date: Sun, 23 Aug 2020 20:06:21 -0400 Subject: [PATCH 1/3] Make sure our readme is proper restructuredText --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 99903f0b9..b9e85872c 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,9 @@ mapping (SAM) in robotics and vision, using Factor Graphs and Bayes Networks as the underlying computing paradigm rather than sparse matrices. + +The current support matrix is:: + | Platform | Compiler | Build Status | |:------------:|:---------:|:-------------:| | Ubuntu 18.04 | gcc/clang | ![Linux CI](https://github.com/borglab/gtsam/workflows/Linux%20CI/badge.svg) | From bba3b6772aab87f40905249a581a893432fa8ff4 Mon Sep 17 00:00:00 2001 From: Fan Jiang Date: Sun, 23 Aug 2020 20:54:38 -0400 Subject: [PATCH 2/3] Remove unnecessary comment --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index b9e85872c..cbd7e35fe 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,6 @@ mapping (SAM) in robotics and vision, using Factor Graphs and Bayes Networks as the underlying computing paradigm rather than sparse matrices. - The current support matrix is:: | Platform | Compiler | Build Status | From b74c053c650f01a4b037753848af8342920c545e Mon Sep 17 00:00:00 2001 From: Fan Jiang Date: Sun, 23 Aug 2020 22:01:49 -0400 Subject: [PATCH 3/3] Proper method to deal with markdown in setup.py --- README.md | 2 +- python/setup.py.in | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cbd7e35fe..3982f5585 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ mapping (SAM) in robotics and vision, using Factor Graphs and Bayes Networks as the underlying computing paradigm rather than sparse matrices. -The current support matrix is:: +The current support matrix is: | Platform | Compiler | Build Status | |:------------:|:---------:|:-------------:| diff --git a/python/setup.py.in b/python/setup.py.in index 55431a9ad..a7acdc4ba 100644 --- a/python/setup.py.in +++ b/python/setup.py.in @@ -27,6 +27,7 @@ setup( author_email='frank.dellaert@gtsam.org', license='Simplified BSD license', keywords='slam sam robotics localization mapping optimization', + long_description_content_type='text/markdown', long_description=readme_contents, # https://pypi.org/pypi?%3Aaction=list_classifiers classifiers=[