Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Decluttered README in the main branch #157

Merged
merged 33 commits into from
Aug 2, 2022
Merged

Decluttered README in the main branch #157

merged 33 commits into from
Aug 2, 2022

Conversation

thedevmanek
Copy link
Contributor

New feature implementation

Changes in the documentation

Implemented feature

  • Removed installation procedure from the main branch and added it to the release/21.09 branch
  • Added Table for quick navigation to the release page

Implementation description

Made the README in the main repo much cleaner and shifted all the release specific information to the release branch.

@marcoag marcoag self-requested a review July 15, 2022 06:22
@marcoag
Copy link
Member

marcoag commented Jul 15, 2022 •
edited
Loading

It seems that you need to fix DCO. Also, can you please resolve conflicts?

@thedevmanek
Copy link
Contributor Author

Done

marcoag
marcoag reviewed Jul 22, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
marcoag
marcoag previously approved these changes Jul 29, 2022
View reviewed changes
marcoag
marcoag reviewed Jul 29, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
mxgrey and others added 23 commits August 2, 2022 13:41
@mxgrey @aaronchongth @thedevmanek
New repos for release 22.02 (#139)
9f2a467 
Signed-off-by: Michael X. Grey <grey@openrobotics.org>
Co-authored-by: Aaron Chong <aaronchongth@gmail.com>
Signed-off-by: Aaron Chong <aaronchongth@gmail.com>
Signed-off-by: Dev Manek <58616961+thedevmanek@users.noreply.github.com>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@luca-della-vedova @thedevmanek
Add ros_ign to be built from source (#144)
33fe8f8 
Signed-off-by: Luca Della Vedova <luca@openrobotics.org>
Signed-off-by: Dev Manek <58616961+thedevmanek@users.noreply.github.com>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@Yadunund @thedevmanek
Add list of fleet adapters (#150)
28b005c 
Signed-off-by: Yadunund <yadunund@gmail.com>
Signed-off-by: Dev Manek <58616961+thedevmanek@users.noreply.github.com>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@youliangtan @thedevmanek
fix rmf ci (#151)
be8f96c 
Signed-off-by: youliang <tan_you_liang@hotmail.com>
Signed-off-by: Dev Manek <58616961+thedevmanek@users.noreply.github.com>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@thedevmanek
Improved documentation of installation
92bec48 
Signed-off-by: thedevmanek <manekdev2001@gmail.com>
Signed-off-by: Dev Manek <58616961+thedevmanek@users.noreply.github.com>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@thedevmanek
Added RMF version
62d3492 
Signed-off-by: thedevmanek <manekdev2001@gmail.com>
Signed-off-by: Dev Manek <58616961+thedevmanek@users.noreply.github.com>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@thedevmanek
Added RMF version in README.md
5612989 
Signed-off-by: thedevmanek <manekdev2001@gmail.com>
Signed-off-by: Dev Manek <58616961+thedevmanek@users.noreply.github.com>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@thedevmanek
removed docs folder
55ece5d 
Signed-off-by: thedevmanek <manekdev2001@gmail.com>
Signed-off-by: Dev Manek <58616961+thedevmanek@users.noreply.github.com>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@thedevmanek
Added version support
c67df2d 
Signed-off-by: thedevmanek <manekdev2001@gmail.com>
Signed-off-by: Dev Manek <58616961+thedevmanek@users.noreply.github.com>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@thedevmanek
Added info about 22.04
21f7162 
Signed-off-by: thedevmanek <manekdev2001@gmail.com>
Signed-off-by: Dev Manek <58616961+thedevmanek@users.noreply.github.com>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@thedevmanek
added badges
50a7f62 
Signed-off-by: thedevmanek <manekdev2001@gmail.com>
Signed-off-by: Dev Manek <58616961+thedevmanek@users.noreply.github.com>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@thedevmanek
Made instructions more generic in the main repo
d5b31bf 
Signed-off-by: Dev Manek <58616961+thedevmanek@users.noreply.github.com>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@aaronchongth @thedevmanek
Adding note regarding uninstalling binaries before source build (#160)
30e53ca 
Signed-off-by: Aaron Chong <aaronchongth@gmail.com>
Signed-off-by: Dev Manek <58616961+thedevmanek@users.noreply.github.com>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@thedevmanek
Removed 22.04 from the table
8432e80 
Signed-off-by: Dev Manek <58616961+thedevmanek@users.noreply.github.com>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@thedevmanek
Removed section of docker container from README.md
413b5d7 
Signed-off-by: Dev Manek <58616961+thedevmanek@users.noreply.github.com>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@xiyuoh @thedevmanek
Add demo fleet adapter build instructions (#122)
7efa12a 
Signed-off-by: Xi Yu Oh <xiyu@openrobotics.org>
Signed-off-by: Dev Manek <58616961+thedevmanek@users.noreply.github.com>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@marcoag @thedevmanek
Minor fixes to releases table.
d2f12f6 
Signed-off-by: Dev Manek <58616961+thedevmanek@users.noreply.github.com>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@thedevmanek
Add section of docker container from README.md
0358166 
Signed-off-by: Dev Manek <58616961+thedevmanek@users.noreply.github.com>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@luca-della-vedova @thedevmanek
Add ros_ign to be built from source (#144)
cc3919f 
Signed-off-by: Luca Della Vedova <luca@openrobotics.org>
Signed-off-by: Dev Manek <58616961+thedevmanek@users.noreply.github.com>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@Yadunund @thedevmanek
Add list of fleet adapters (#150)
d0d17ab 
Signed-off-by: Yadunund <yadunund@gmail.com>
Signed-off-by: Dev Manek <58616961+thedevmanek@users.noreply.github.com>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@youliangtan @thedevmanek
fix rmf ci (#151)
0c7b11d 
Signed-off-by: youliang <tan_you_liang@hotmail.com>
Signed-off-by: Dev Manek <58616961+thedevmanek@users.noreply.github.com>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@mxgrey @aaronchongth @thedevmanek
New repos for release 22.02 (#139)
be6f23e 
Signed-off-by: Michael X. Grey <grey@openrobotics.org>
Co-authored-by: Aaron Chong <aaronchongth@gmail.com>
Signed-off-by: Aaron Chong <aaronchongth@gmail.com>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@luca-della-vedova @thedevmanek
Add ros_ign to be built from source (#144)
ff87373 
Signed-off-by: Luca Della Vedova <luca@openrobotics.org>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
Yadunund and others added 9 commits August 2, 2022 13:41
@Yadunund @thedevmanek
Add list of fleet adapters (#150)
7d2fe64 
Signed-off-by: Yadunund <yadunund@gmail.com>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@youliangtan @thedevmanek
fix rmf ci (#151)
41d31dd 
Signed-off-by: youliang <tan_you_liang@hotmail.com>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@thedevmanek
Apply suggestions from code review
337b41b 
Co-authored-by: Marco A. Gutiérrez <marco@openrobotics.org>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@mxgrey @aaronchongth @thedevmanek
New repos for release 22.02 (#139)
30d2338 
Signed-off-by: Michael X. Grey <grey@openrobotics.org>
Co-authored-by: Aaron Chong <aaronchongth@gmail.com>
Signed-off-by: Aaron Chong <aaronchongth@gmail.com>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@luca-della-vedova @thedevmanek
Add ros_ign to be built from source (#144)
4c5c816 
Signed-off-by: Luca Della Vedova <luca@openrobotics.org>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@youliangtan @thedevmanek
fix rmf ci (#151)
84eda87 
Signed-off-by: youliang <tan_you_liang@hotmail.com>
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@thedevmanek
rmf.repos reverted back to last stable commit
1d0b789 
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@thedevmanek
rmf.repos reverted back
c2e4591 
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@thedevmanek
Merge branch 'main' into main
80255aa
marcoag
marcoag previously approved these changes Aug 2, 2022
View reviewed changes
@thedevmanek
extra line in the end of rmf.repos
31d8910 
Signed-off-by: Dev Manek <manekdev2001@gmail.com>
@marcoag marcoag merged commit 92972bf into open-rmf:main Aug 2, 2022
Yadunund added a commit that referenced this pull request Aug 25, 2022
@thedevmanek @mxgrey
@aaronchongth @luca-della-vedova @Yadunund @youliangtan @xiyuoh
Decluttered README in the main branch (#157)
52aaeee 
Signed-off-by: Dev Manek <manekdev2001@gmail.com>

Co-authored-by: Grey <grey@openrobotics.org>
Co-authored-by: Aaron Chong <aaronchongth@gmail.com>
Co-authored-by: Luca Della Vedova <luca@openrobotics.org>
Co-authored-by: Yadu <yadunund@gmail.com>
Co-authored-by: youliang <tan_you_liang@hotmail.com>
Co-authored-by: Xiyu <ohxiyu@gmail.com>
Co-authored-by: Marco A. Gutiérrez <marco@openrobotics.org>
Signed-off-by: Yadunund <yadunund@gmail.com>
thedevmanek added a commit to thedevmanek/rmf that referenced this pull request Sep 5, 2022
@thedevmanek @mxgrey
@aaronchongth @luca-della-vedova @Yadunund @youliangtan @xiyuoh
Decluttered README in the main branch (open-rmf#157)
44ab7cc 
Signed-off-by: Dev Manek <manekdev2001@gmail.com>

Co-authored-by: Grey <grey@openrobotics.org>
Co-authored-by: Aaron Chong <aaronchongth@gmail.com>
Co-authored-by: Luca Della Vedova <luca@openrobotics.org>
Co-authored-by: Yadu <yadunund@gmail.com>
Co-authored-by: youliang <tan_you_liang@hotmail.com>
Co-authored-by: Xiyu <ohxiyu@gmail.com>
Co-authored-by: Marco A. Gutiérrez <marco@openrobotics.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marcoag marcoag marcoag approved these changes

Assignees
No one assigned
Labels
None yet
Projects
Document Open-RMF
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@thedevmanek @marcoag @mxgrey @luca-della-vedova @Yadunund @youliangtan @aaronchongth @xiyuoh