Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
p3root committed Feb 27, 2019
1 parent a11e077 commit aaad0b6
Showing 1 changed file with 51 additions and 1 deletion.
52 changes: 51 additions & 1 deletion Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,58 @@ I currently use the system on a Raspberry.PI3. It runs also on Windows and Mac,
## Raspberry.PI
You can download the latest image & binaries [here...](https://github.com/automatica-core/automatica/releases)

# Project structure
This project is a mono repository. The master & develop branch will be splitted nightly.

The Structure of the project is as follows.

.
├── bin/ # Bin tools for splitting the repo
├── build/ # Some build tools for the project (alternatively `doc`)
├── docker/ # Docker build files
├── images/ # Image files displayed in the readme.md
├── src/ # Source files
| ├── automatica.core # The core system for automatica.core
| ├── automatica.drivers # Automatica drivers - split repository
| ├── automatica.logics # Automatica logics - split repository
├── LICENSE
└── README.md

# How to build
First step is to build the angular app.

## Frontend
~~~
cd src/automatica.core/Automatica.WebNew
npm install
npm run start
The angular dist folder is in src/automatica.core/Automatica.Core/wwwroot
~~~

## Backend
~~~
cd src/automatica.core
dotnet restore
dotnet build
~~~

or open the src/automatica.core/automatica.core.sln with Visual Studio an hit F5.

You can download the latest plugins with the automatica-cli. More [here...](https://github.com/automatica-core/automatica.core.cli)


# Contribute
Comming soon...
Please refer to each project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.

1. **Fork** the repo on GitHub
2. **Clone** the project to your own machine
3. **Commit** changes to your own branch
4. **Push** your work back up to your fork
5. Submit a **Pull request** so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request! Pull request must have no merge conflicts!


# Online Demo
The online demo is available [here...](https://demo.automaticacore.com/).
Expand Down

0 comments on commit aaad0b6

Please sign in to comment.