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.

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

Improve user instruction #105

Open
5 of 6 tasks
130s opened this issue Jan 17, 2017 · 7 comments
Open
5 of 6 tasks

Improve user instruction #105

130s opened this issue Jan 17, 2017 · 7 comments

Comments

@130s
Copy link
Member

130s commented Jan 17, 2017

Some complaints feedback from active users, e.g. ros-industrial-attic/bezier#153

Indeed README gets necessarily but surely complexed.

@130s 130s mentioned this issue Jan 17, 2017
26 tasks
@mathias-luedtke
Copy link
Member

mathias-luedtke commented Jan 17, 2017

Pehaps we should split README.md into different chapters (-> doc directory).
And start with a TL;DR section with a minimal example:

sudo: required 
dist: trusty 
language: generic 
env:
  - ROS_DISTRO="indigo"
install:
  - git clone --depth 1 https://github.com/ros-industrial/industrial_ci.git .ci_config  
script: 
  - .ci_config/travis.sh

@VictorLamoine
Copy link
Contributor

VictorLamoine commented Jan 17, 2017

Complaint is a strong word. You have done some awesome work with this repository.
Please don't feel offended 🤗

@130s 130s self-assigned this Jan 18, 2017
@130s 130s changed the title Add more sample config Improve user instruction Jan 18, 2017
@130s
Copy link
Member Author

130s commented Jan 18, 2017

@VictorLamoine Thanks. I've seen "complaint" in OSS is often used as the same meaning as "feedback", and that was what I meant ;)

@mathias-luedtke
Copy link
Member

A template might help preventing issues like #254

130s added a commit to 130s/industrial_ci that referenced this issue Feb 5, 2018
@130s
Copy link
Member Author

130s commented Feb 5, 2018

  • provide a template .travis.yml content so that users simply download in their .travis.yml.

Template being added to #234

130s added a commit to 130s/industrial_ci that referenced this issue Apr 23, 2018
@130s 130s added the document label Jul 11, 2018
@mathias-luedtke
Copy link
Member

The quickstart config is a little bit outdated and not really complete (#336).

@130s
Copy link
Member Author

130s commented Dec 3, 2018

Can't find "optional-customize-catkin-config" section. And customize-catkin-config section link is working. Checked.

@130s 130s removed their assignment Aug 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants