Skip to content

Commit 7b66afc

Browse files
committed
Replace README with the same content, add issue pointer
1 parent 2c2849c commit 7b66afc

2 files changed

Lines changed: 18 additions & 84 deletions

File tree

README.md

Lines changed: 16 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -1,93 +1,25 @@
1-
# The Minimal theme
1+
# micro-ROS project
22

3-
[![Build Status](https://travis-ci.org/pages-themes/minimal.svg?branch=master)](https://travis-ci.org/pages-themes/minimal) [![Gem Version](https://badge.fury.io/rb/jekyll-theme-minimal.svg)](https://badge.fury.io/rb/jekyll-theme-minimal)
3+
![](assets/img/logo.png)
44

5-
*Minimal is a Jekyll theme for GitHub Pages. You can [preview the theme to see what it looks like](http://pages-themes.github.io/minimal), or even [use it today](#usage).*
5+
[micro-ROS](https://cordis.europa.eu/project/rcn/213167_en.html) puts ROS2 onto microcontrollers, making them first class participants of the ROS 2 environment.
66

7-
![Thumbnail of minimal](thumbnail.png)
7+
From the level of ROS onwards, we strive to re-use as much as possible from ROS 2, and be as compatible with it as possible. In some areas, we will probably do custom implementations optimized for resource use. This will definitely include TF, and maybe other areas such as scheduling. These optimized implementations may also be interesting for use with "normal" ROS2.
88

9-
## Usage
9+
We'll update this README as we proceed. For now, you can check out our work on:
10+
- Real-Time Operating System: [https://github.com/microROS/NuttX](https://github.com/microROS/NuttX)
11+
- Reference hardware: [https://github.com/microROS/hardware](https://github.com/microROS/hardware)
12+
- Build infrastructure for embedded development using docker: [https://github.com/microROS/docker](https://github.com/microROS/docker)
1013

11-
To use the Minimal theme:
14+
### Architecture
15+
The micro-ROS architecture is a work in progress. It's modular and built with the following ingredients:
1216

13-
1. Add the following to your site's `_config.yml`:
17+
- A Real-Time Operating System (RTOS). This includes at least NuttX, and possibly others.
18+
- An embedded communications middleware, at least [Micro XRCE-DDS](https://github.com/eProsima/Micro-XRCE-DDS)
19+
- The [ROS client library](https://github.com/microROS/rcl)
1420

15-
```yml
16-
theme: jekyll-theme-minimal
17-
```
21+
A first approach (yet not final) of the architecture is represented below:
1822

19-
2. Optionally, if you'd like to preview your site on your computer, add the following to your site's `Gemfile`:
23+
![](assets/img/micro-ROS_architecture.png)
2024

21-
```ruby
22-
gem "github-pages", group: :jekyll_plugins
23-
```
24-
25-
26-
27-
## Customizing
28-
29-
### Configuration variables
30-
31-
Minimal will respect the following variables, if set in your site's `_config.yml`:
32-
33-
```yml
34-
title: [The title of your site]
35-
description: [A short description of your site's purpose]
36-
```
37-
38-
Additionally, you may choose to set the following optional variables:
39-
40-
```yml
41-
logo: [Location of the logo]
42-
show_downloads: ["true" or "false" to indicate whether to provide a download URL]
43-
google_analytics: [Your Google Analytics tracking ID]
44-
```
45-
46-
### Stylesheet
47-
48-
If you'd like to add your own custom styles:
49-
50-
1. Create a file called `/assets/css/style.scss` in your site
51-
2. Add the following content to the top of the file, exactly as shown:
52-
```scss
53-
---
54-
---
55-
56-
@import "{{ site.theme }}";
57-
```
58-
3. Add any custom CSS (or Sass, including imports) you'd like immediately after the `@import` line
59-
60-
### Layouts
61-
62-
If you'd like to change the theme's HTML layout:
63-
64-
1. [Copy the original template](https://github.com/pages-themes/minimal/blob/master/_layouts/default.html) from the theme's repository<br />(*Pro-tip: click "raw" to make copying easier*)
65-
2. Create a file called `/_layouts/default.html` in your site
66-
3. Paste the default layout content copied in the first step
67-
4. Customize the layout as you'd like
68-
69-
## Roadmap
70-
71-
See the [open issues](https://github.com/pages-themes/minimal/issues) for a list of proposed features (and known issues).
72-
73-
## Project philosophy
74-
75-
The Minimal theme is intended to make it quick and easy for GitHub Pages users to create their first (or 100th) website. The theme should meet the vast majority of users' needs out of the box, erring on the side of simplicity rather than flexibility, and provide users the opportunity to opt-in to additional complexity if they have specific needs or wish to further customize their experience (such as adding custom CSS or modifying the default layout). It should also look great, but that goes without saying.
76-
77-
## Contributing
78-
79-
Interested in contributing to Minimal? We'd love your help. Minimal is an open source project, built one contribution at a time by users like you. See [the CONTRIBUTING file](docs/CONTRIBUTING.md) for instructions on how to contribute.
80-
81-
### Previewing the theme locally
82-
83-
If you'd like to preview the theme locally (for example, in the process of proposing a change):
84-
85-
1. Clone down the theme's repository (`git clone https://github.com/pages-themes/minimal`)
86-
2. `cd` into the theme's directory
87-
3. Run `script/bootstrap` to install the necessary dependencies
88-
4. Run `bundle exec jekyll serve` to start the preview server
89-
5. Visit [`localhost:4000`](http://localhost:4000) in your browser to preview the theme
90-
91-
### Running tests
92-
93-
The theme contains a minimal test suite, to ensure a site with the theme would build successfully. To run the tests, simply run `script/cibuild`. You'll need to run `script/bootstrap` one before the test script will work.
25+
Got questions, [open an issue](https://github.com/microROS/micro-ROS/issues/new) and we'll get back to you as soon as possible.

index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,5 @@ The micro-ROS architecture is a work in progress. It's modular and built with th
2121
A first approach (yet not final) of the architecture is represented below:
2222

2323
![](assets/img/micro-ROS_architecture.png)
24+
25+
Got questions, [open an issue](https://github.com/microROS/micro-ROS/issues/new) and we'll get back to you as soon as possible.

0 commit comments

Comments
 (0)