search

ros-industrial / industrial_ci

Easy continuous integration repository for ROS repositories
Apache License 2.0
245 stars 127 forks source link

Improve user instruction #105

Open 130s opened 7 years ago

130s commented 7 years ago

Some complaints feedback from active users, e.g. https://github.com/ros-industrial-consortium/bezier/issues/153

Indeed README gets necessarily but surely complexed.

mathias-luedtke commented 7 years ago

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 commented 7 years ago

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

130s commented 7 years ago

@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 commented 6 years ago

A template might help preventing issues like #254

130s commented 6 years ago
  • provide a template .travis.yml content so that users simply download in their .travis.yml.

Template being added to https://github.com/ros-industrial/industrial_ci/pull/234

mathias-luedtke commented 5 years ago

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

130s commented 5 years ago

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