Merge pull request #17 from ichiro-its/add-documentation

threeal · web-flow · commit 98bab82949e1 · 2021-04-24T15:07:38.000+07:00
Add First Update
diff --git a/.github/workflows/build-and-test.yml b/.github/workflows/build-and-test.yml
@@ -0,0 +1,18 @@
+name: Build and Test
+on:
+  pull_request:
+    branches: [ master ]
+  push:
+    branches: [ master ]
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checking out
+        uses: actions/checkout@v2.3.4
+      - name: Building and testing
+        uses: ichiro-its/ros2-ci@v1.0.0
+        with:
+          ros2-distro: foxy
+          apt-packages: libopencv-dev
+          external-repos: ichiro-its/shisen_interfaces#v0.1.0
diff --git a/.github/workflows/ros2-ci.yml b/.github/workflows/ros2-ci.yml
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,7 @@
 .*
 
-!.git*
+!.git*
+
+build
+install
+log
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -22,8 +22,7 @@ find_package(shisen_interfaces REQUIRED)
 
 add_library(${PROJECT_NAME}
   "src/${PROJECT_NAME}/camera.cpp"
-  "src/${PROJECT_NAME}/viewer.cpp"
-)
+  "src/${PROJECT_NAME}/viewer.cpp")
 
 target_include_directories(${PROJECT_NAME} PUBLIC
   $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
@@ -32,8 +31,7 @@ target_include_directories(${PROJECT_NAME} PUBLIC
 ament_target_dependencies(${PROJECT_NAME}
   OpenCV
   rclcpp
-  shisen_interfaces
-)
+  shisen_interfaces)
 
 install(DIRECTORY "include" DESTINATION ".")
 
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,3 +1,3 @@
 Any contribution that you make to this repository will
 be under the MIT license, as dictated by that
-[license](https://opensource.org/licenses/MIT).
+[license](https://opensource.org/licenses/MIT).
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2021 Ichiro ITS
+Copyright (c) 2020-2021 ICHIRO ITS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
@@ -1,3 +1,12 @@
 # Shisen
 
-**Shisen** is a tools to capture image from a camera and modify camera related settings.
+[![latest version](https://img.shields.io/github/v/release/ichiro-its/shisen)](https://github.com/ichiro-its/shisen/releases/)
+[![milestone](https://img.shields.io/github/milestones/progress/ichiro-its/shisen/1?label=milestone)](https://github.com/ichiro-its/shisen/milestone/1)
+[![license](https://img.shields.io/github/license/ichiro-its/shisen)](./LICENSE)
+[![test status](https://img.shields.io/github/workflow/status/ichiro-its/shisen/Build%20and%20Test?label=test)](https://github.com/ichiro-its/shisen/actions)
+
+This package provides a camera tools library for [ROS 2](https://docs.ros.org/en/foxy/index.html) projects.
+
+## License
+
+This project is maintained by [ICHIRO ITS](https://github.com/ichiro-its) and licensed under the [MIT License](./LICENSE).
diff --git a/include/shisen/camera.hpp b/include/shisen/camera.hpp
@@ -1,4 +1,4 @@
-// Copyright 2020-2021 Ichiro ITS
+// Copyright 2020-2021 ICHIRO ITS
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal
diff --git a/include/shisen/viewer.hpp b/include/shisen/viewer.hpp
@@ -1,4 +1,4 @@
-// Copyright 2020-2021 Ichiro ITS
+// Copyright 2020-2021 ICHIRO ITS
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal
diff --git a/package.xml b/package.xml
@@ -2,8 +2,8 @@
 <?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
   <name>shisen</name>
-  <version>0.4.0</version>
-  <description>A camera tools for ROS 2</description>
+  <version>0.1.0</version>
+  <description>Camera tools for ROS 2</description>
   <maintainer email="alfi.maulana.f@gmail.com">Alfi Maulana</maintainer>
   <license>MIT License</license>
   <buildtool_depend>ament_cmake_ros</buildtool_depend>
diff --git a/src/camera_main.cpp b/src/camera_main.cpp
@@ -1,4 +1,4 @@
-// Copyright 2020-2021 Ichiro ITS
+// Copyright 2020-2021 ICHIRO ITS
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal
diff --git a/src/shisen/camera.cpp b/src/shisen/camera.cpp
@@ -1,4 +1,4 @@
-// Copyright 2020-2021 Ichiro ITS
+// Copyright 2020-2021 ICHIRO ITS
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal
diff --git a/src/shisen/viewer.cpp b/src/shisen/viewer.cpp
@@ -1,4 +1,4 @@
-// Copyright 2020-2021 Ichiro ITS
+// Copyright 2020-2021 ICHIRO ITS
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal
diff --git a/src/viewer_main.cpp b/src/viewer_main.cpp
@@ -1,4 +1,4 @@
-// Copyright 2020-2021 Ichiro ITS
+// Copyright 2020-2021 ICHIRO ITS
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal

-Original file line number
+Diff line change
@@ @@ -1,3 +1,7 @@ @@
 .*
 -!.git*
 +!.git*
++
 +build
 +install
 +log
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// Copyright 2020-2021 Ichiro ITS`
	`1`	`+// Copyright 2020-2021 ICHIRO ITS`
`2`	`2`	`//`
`3`	`3`	`// Permission is hereby granted, free of charge, to any person obtaining a copy`
`4`	`4`	`// of this software and associated documentation files (the "Software"), to deal`