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

Create all cogip manifest files #1

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 97 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
## Pre-requisites ##

This documentation supports Ubuntu 20.04 LTS version.
However command listed below should work with any recent debian-like Linux
distribution.

### git ###

From https://git-scm.com/:
Git is a free and open source distributed version control system designed to
handle everything from small to very large projects with speed and efficiency.

To install git:

```bash
$ sudo apt install git
```

For more informations: https://git-scm.com/

### repo ###

From https://gerrit.googlesource.com/git-repo/:
Repo is a tool built on top of Git. Repo helps manage many Git repositories,
does the uploads to revision control systems, and automates parts of the
development workflow. Repo is not meant to replace Git, only to make it easier
to work with Git. The repo command is an executable Python script that you can
put anywhere in yoaur path.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/yoaur/your/


To install repo:

```bash
$ mkdir ~/.bin
$ echo "PATH=~/.bin:\$PATH" >> ~/.bashrc && source ~/.bashrc
$ curl https://storage.googleapis.com/git-repo-downloads/repo > ~/.bin/repo
```

For more informations: https://gerrit.googlesource.com/git-repo/+/refs/heads/master/README.md

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/informations/information/


## Get the project ##

### Full project ###

To get the COGIP full source tree :

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No space before :


```bash
$ mkdir cogip/ -p && cd cogip/
$ repo init -u [email protected]:cogip/cogip-manifest.git -m cogip-manifest.xml
$ repo sync
```

#### yocto-build project ####

The yocto-build project is the Yocto linux distribution installed on robot
MPU board.

Refer to `cogip/yocto-build/README.md` for more information.

To get the COGIP pi project source tree only:

```bash
$ mkdir cogip/ -p && cd cogip/
$ repo init -u [email protected]:cogip/cogip-manifest.git -m cogip-pi.xml
$ repo sync
$ cd yocto-build/
```

#### mcu-firmware project ####

The mcu-firmware project is the firmware flashed on robot MCU board.

To get the COGIP mcu-firmware project source tree only:

```bash
$ mkdir cogip/ -p && cd cogip/
$ repo init -u [email protected]:cogip/cogip-manifest.git -m cogip-mcu-firmware.xml
$ repo sync
$ cd mcu-firmware/
```

Refer to `cogip/mcu-firmware/README.md` for more information.

#### simulation project ####

The simulation project is the source code of simulator and co-pilot application.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/simulator/monitor/
s/co-pilot/copilot/



Comment on lines +86 to +87

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two empty lines.

To get the COGIP mcu-firmware project source tree only:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/mcu-firmware/simulation/


```bash
$ mkdir cogip/ -p && cd cogip/
$ repo init -u [email protected]:cogip/cogip-manifest.git -m cogip-simulation.xml
$ repo sync
$ cd simulation/
```

Refer to `cogip/simulation/README.md` or https://cogip.github.io/simulation for more information.
41 changes: 4 additions & 37 deletions cogip-manifest.xml
Original file line number Diff line number Diff line change
@@ -1,40 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<manifest>
<!--List of remotes to use-->
<remote name="cogip" alias="origin" fetch="ssh://[email protected]/cogip"/>
<remote name="riot" alias="origin" fetch="ssh://[email protected]/RIOT-OS"/>

<!--Cogip repositories-->
<project name="mcu-firmware"
path="mcu-firmware"
remote="cogip"
revision="master"
groups="cogip" />

<project name="lidar-firmware"
path="lidar-firmware"
remote="cogip"
revision="master"
groups="cogip" />

<project name="simulation"
path="simulation"
remote="cogip"
revision="master"
groups="cogip" />

<project name="cogip-manifest"
path="manifest"
remote="cogip"
revision="master"
groups="cogip" />

<!--External repositories-->
<project name="RIOT"
path="RIOT"
remote="riot"
revision="refs/tags/2020.07"
clone-depth="1"
groups="riot" />

<!--List of sub-manifest -->
<include name="cogip-mcu-firmware.xml" />
<include name="cogip-yocto.xml" />
<include name="cogip-simulation.xml" />
</manifest>
22 changes: 22 additions & 0 deletions cogip-mcu-firmware.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<?xml version="1.0" encoding="UTF-8"?>
<manifest>
<!--List of remotes to use-->
<remote name="cogip" alias="origin" fetch="ssh://[email protected]/cogip"/>
<remote name="riot" alias="origin" fetch="ssh://[email protected]/RIOT-OS"/>

<!--Cogip repositories-->
<project name="mcu-firmware"
path="firmware/mcu-firmware"
remote="cogip"
revision="master"
groups="cogip" />

<!--External repositories-->
<project name="RIOT"
path="firmware/RIOT"
remote="riot"
revision="refs/tags/2020.07"

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are now on RIOT-2021.07.

clone-depth="1"
groups="riot" />

</manifest>
54 changes: 54 additions & 0 deletions cogip-pi.xml.orig
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
<?xml version="1.0" encoding="UTF-8"?>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file must not be committed.

<manifest>
<!-- List of remotes to use -->
<remote name="cogip" alias="origin" fetch="ssh://[email protected]/cogip"/>
<remote name="riot" alias="origin" fetch="ssh://[email protected]/RIOT-OS"/>
<remote name="yocto" alias="origin" fetch="git://git.yoctoproject.org"/>

<!-- Cogip repositories -->
<project name="yocto-build"
path="pi"
remote="cogip"
revision="main"
groups="cogip" />
<<<<<<< HEAD
=======
<project name="meta-cogip-bsp"
path="yocto-build/layers/meta-cogip-bsp"
remote="cogip"
revision="main"
groups="cogip" />
<project name="meta-cogip-distro"
path="yocto-build/layers/meta-cogip-distro"
remote="cogip"
revision="main"
groups="cogip" />
>>>>>>> a5a9ebd... fix yocto-build

<!-- Yocto repositories -->
<project name="poky"
path="yocto-build/layers/poky"
remote="yocto"
revision="dunfell"
groups="yocto" />
<project name="meta-raspberrypi"
path="yocto-build/layers/meta-raspberrypi"
remote="yocto"
revision="dunfell"
groups="yocto" />
<<<<<<< HEAD
=======

<!-- 3rd party Yocto layers -->
<project name="meta-openembedded"
path="yocto-build/layers/meta-openembedded"
remote="oe"
revision="dunfell"
groups="yocto" />
<project name="meta-ptx"
path="yocto-build/layers/meta-ptx"
remote="ptx"
revision="dunfell"
groups="yocto" />
>>>>>>> a5a9ebd... fix yocto-build
</manifest>
12 changes: 12 additions & 0 deletions cogip-simulation.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<manifest>
<!--List of remotes to use-->
<remote name="cogip" alias="origin" fetch="ssh://[email protected]/cogip"/>

<project name="simulation"
path="simulation"
remote="cogip"
revision="master"
groups="cogip"
sync-s="true" />
</manifest>
50 changes: 50 additions & 0 deletions cogip-yocto.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<?xml version="1.0" encoding="UTF-8"?>
<manifest>
<!-- List of remotes to use -->
<remote name="cogip" alias="origin" fetch="ssh://[email protected]/cogip"/>
<remote name="oe" alias="origin" fetch="git://git.openembedded.org"/>
<remote name="ptx" alias="origin" fetch="git://git.pengutronix.de"/>
<remote name="riot" alias="origin" fetch="ssh://[email protected]/RIOT-OS"/>
<remote name="yocto" alias="origin" fetch="git://git.yoctoproject.org"/>

<!-- Cogip repositories -->
<project name="yocto-build"
path="yocto-build"
remote="cogip"
revision="main"
groups="cogip" />
<project name="meta-cogip-bsp"
path="yocto-build/layers/meta-cogip-bsp"
remote="cogip"
revision="main"
groups="cogip" />
<project name="meta-cogip-distro"
path="yocto-build/layers/meta-cogip-distro"
remote="cogip"
revision="main"
groups="cogip" />

<!-- Yocto repositories -->
<project name="poky"
path="yocto-build/layers/poky"
remote="yocto"
revision="dunfell"
groups="yocto" />
<project name="meta-raspberrypi"
path="yocto-build/layers/meta-raspberrypi"
remote="yocto"
revision="dunfell"
groups="yocto" />

<!-- 3rd party Yocto layers -->
<project name="meta-openembedded"
path="yocto-build/layers/meta-openembedded"
remote="oe"
revision="dunfell"
groups="yocto" />
<project name="meta-ptx"
path="yocto-build/layers/meta-ptx"
remote="ptx"
revision="dunfell"
groups="yocto" />
</manifest>