From fad9df113ae792abec99fd8d23e41d674269b7c6 Mon Sep 17 00:00:00 2001 From: Penguin Date: Fri, 3 Jul 2020 04:46:26 -0500 Subject: [PATCH] . --- .gitignore | 1 + Cargo.toml | 1 + README.md | 2 +- README.md.temp | 40 ---------------------------------------- 4 files changed, 3 insertions(+), 41 deletions(-) delete mode 100644 README.md.temp diff --git a/.gitignore b/.gitignore index 53eaa21..b77afbf 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ /target **/*.rs.bk +README.md.temp diff --git a/Cargo.toml b/Cargo.toml index 98d1cd5..2c0fd8b 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -5,6 +5,7 @@ authors = ["Penguin <...>"] edition = "2018" repository = "https://github.com/Embedded-Penguin/ePenguin-igloo/" readme = "README.md" +description = "Igloo is a package and project manager. It is used for bare metal (for now only bare metal) embedded systems. In the embedded world, there is a big gap between how one would write code for embedded systems between manufacturers. As of today, 7/2/20, there is really no easy way to go about writing code for any embedded system from scratch. Most of the time, you need to download headers from some unknown location, figure out your hardware interface, find the proper toolchain, etc. This forces embedded developers and engineers to spend a lot of unnecessary time on DevOps and less time on firmware engineering. Igloo aims to solve this problem. Igloo is in its early stages of development." exclude = [ "old/", ] diff --git a/README.md b/README.md index 6352090..2782d1b 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ### What is Igloo? -Igloo is a package and project manager. It is used for bare metal (for now only bare metal) embedded systems. In the embedded world, there is a big gap between how one would write code for embedded systems between manufacturers. As of today, 7/2/20, there is really no easy way to go about writing code for any embedded system from scratch. Most of the time, you need to download headers from some unknown location, figure out your hardware interface, find the proper toolchain, etc. This forces embedded developers and engineers to spend a lot of unnecessary time on DevOps and less time on firmware engineering. Igloo aims to solve this problem. +Igloo is a package and project manager. It is used for bare metal (for now only bare metal) embedded systems. In the embedded world, there is a big gap between how one would write code for embedded systems between manufacturers. As of today, 7/2/20, there is really no easy way to go about writing code for any embedded system from scratch. Most of the time, you need to download headers from some unknown location, figure out your hardware interface, find the proper toolchain, etc. This forces embedded developers and engineers to spend a lot of unnecessary time on DevOps and less time on firmware engineering. Igloo aims to solve this problem. Igloo is in its early stages of development. ### How does Igloo help with this problem? diff --git a/README.md.temp b/README.md.temp deleted file mode 100644 index 6352090..0000000 --- a/README.md.temp +++ /dev/null @@ -1,40 +0,0 @@ -# ePenguin-Igloo - -### What is Igloo? - -Igloo is a package and project manager. It is used for bare metal (for now only bare metal) embedded systems. In the embedded world, there is a big gap between how one would write code for embedded systems between manufacturers. As of today, 7/2/20, there is really no easy way to go about writing code for any embedded system from scratch. Most of the time, you need to download headers from some unknown location, figure out your hardware interface, find the proper toolchain, etc. This forces embedded developers and engineers to spend a lot of unnecessary time on DevOps and less time on firmware engineering. Igloo aims to solve this problem. - -### How does Igloo help with this problem? - -This tool allows you to create projects for supported mcus instantly. As long as your hardware is supported, Igloo will just make the project for you. It also allows you to add pre-written software modules, just in case you don't want to write your own. - -### Status Guide -| Icon | Description | -| --- | --- | -| :grey_exclamation: | Not supported | -| :exclamation: | In Development | -| :grey_question: | Unstable | -| :question: | Experimental | -| :heavy_check_mark: | Tentatively Working | -| :white_check_mark: | Stable | - -##### Status Guide Description - - Not Supported: This means it is not currently supported. It does not mean it will never be supported. - - In Development: Yet to be released for use at all. We're working on it. - - Unstable: A version of this is out for public development, but it doesn't work yet. - - Experimental: A version of this is out for public developement and testing. It may or may not work. - - Tentatively Working: Some form of this works. It just may not be working in the right way yet. - - Stable: This works as far as we know. Any bugs are minor and should not interfere with use. -### Supported Platforms - -| Platform | Status | -| --- | --- | -| Windows | :exclamation: | -| Linux | :exclamation: | -| MacOS | :exclamation: | - -### Installation -- TBD - -### Usage -- TBD - -### How to contribute -- TBD