From 8a36fd513d5981cd25663dbc1ad686f8111ab773 Mon Sep 17 00:00:00 2001 From: Anette Uttisrud Date: Tue, 8 Feb 2022 13:48:35 +0100 Subject: [PATCH 1/2] Remove sudo from docker-compose commands --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1eda46912..688ab1834 100644 --- a/README.md +++ b/README.md @@ -26,17 +26,17 @@ sudo apt install docker-compose Build the docker container: ``` -sudo docker-compose build +docker-compose build ``` Start Flotilla by running: ``` -sudo docker-compose up +docker-compose up ``` or ``` -sudo docker-compose up --build +docker-compose up --build ``` From d606f9f01fb07c2c216088e92262d24aeff06256 Mon Sep 17 00:00:00 2001 From: Anette Uttisrud Date: Tue, 8 Feb 2022 14:31:32 +0100 Subject: [PATCH 2/2] Add contributing guidelines --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 688ab1834..857eb0327 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Flotilla Flotilla is the main point of access for operators to interact with multiple robots in a facility. The application -consists of a [frontend](frontend/README.md) in React, a [backend](backend/README.md) in Python using the FastAPI -framework and a Mosquitto MQTT Broker. +consists of a [frontend](frontend) in React, a [backend](backend) in Python using the FastAPI +framework and a Mosquitto MQTT [Broker](broker). ## Setup @@ -12,6 +12,8 @@ For development, please fork the repository. Then, clone the repository: git clone https://github.com/equinor/flotilla ``` +Please see separate installation and setup guides for [frontend](frontend), [backend](backend), and [Broker](broker). + ## Run with docker Install docker using the [official documentation](https://docs.docker.com/engine/install/ubuntu/). @@ -40,3 +42,9 @@ or ``` docker-compose up --build ``` + +## Contributing + +We welcome all kinds of contributions, including code, bug reports, issues, feature requests, and documentation. The preferred way of submitting a contribution is to either make an [issue](https://github.com/equinor/isar/issues) on github or by forking the project on github and making a pull requests. + +We write our commit messages according to [this guide](https://cbea.ms/git-commit/).