Skip to content

Update readme.md #1

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.

Sign up for GitHub

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

Open
iriark01 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update readme.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 8 additions & 11 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,20 @@

yotta is a tool that we're building at [mbed](https://mbed.org), to make it
easier to build better software written in C, C++ or other C-family languages.
It's still early in development, so if you have questions/feedback or issues,
It's still early in development, so if you have questions, feedback or issues,
please [report them](https://github.com/ARMmbed/yotta/issues).

### Installation
yotta is written in
[python](https://www.python.org/downloads/release/python-279/), and is
[Python](https://www.python.org/downloads/release/python-279/), and is
installed using [pip](http://pip.readthedocs.org/en/latest/installing.html).
Install yotta itself by running:

```bash
pip install yotta
```

**Note that yotta needs several non-python dependencies to be installed
**Note that yotta needs several non-Python dependencies to be installed
correctly in order to do anything useful.** Please follow the **[detailed
installation instructions](http://docs.yottabuild.org/#installing)** on the
yotta docs website to ensure you have a working installation.
Expand All @@ -32,29 +32,26 @@ documentation.
The best way to get started is to [follow the
tutorial](http://docs.yottabuild.org/tutorial/tutorial.html).

### What `yotta` does
### What `yotta` Does
yotta downloads the software components that your program depends on. It's
similar in concept to npm, pip or gem: although because C and C++ are compiled
languages, yotta also controls the build of your software in order to ensure
similar in concept to npm, pip or gem, although because C and C++ are compiled
languages, yotta also controls the build of your software in order to ensure that
downloaded modules are available to use in your code.

To install a new module, you run `yotta install --save <modulename>`, and yotta
will install both the module you've specified and any of its dependencies that
you don't already have installed. It will also update your module's description
file to reflect the new dependency.

The best way to really understand how yotta works is to [follow the
tutorial](http://docs.yottabuild.org/tutorial/tutorial.html).

### Further Documentation
For further documentation see the [yotta docs](http://docs.yottabuild.org)
website.

### Tips
* `yt` is a shorthand for the `yotta` command, and it's much quicker to type!
* yotta is strongly influenced by [npm](http://npmjs.org), the awesome node.js
* yotta is strongly influenced by [npm](http://npmjs.org), the awesome Node.js
software packaging system. Much of the syntax for module description and
commands is very similar.

### License
### Licence
yotta is licensed under Apache-2.0