Update README.md

This commit is contained in:
Ibrahim Abd Elkader 2020-12-19 04:17:49 +02:00 committed by GitHub
parent b478e4c291
commit 9a7eb9e054
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -2,13 +2,13 @@
This guide covers how to install the OpenMV Cam firmware development environment on Windows, Mac, and Linux. This guide covers how to install the OpenMV Cam firmware development environment on Windows, Mac, and Linux.
**If you are looking for information on how to use the OpenMV Cam from the python level interface please see our [forums](http://openmv.io/forums) or [docs](http://openmv.io/docs). This README details how to setup the development enviornment to compile your OpenMV Cam's firmware.** **If you are looking for information on how to use the OpenMV Cam from the python level interface please see our [forums](http://openmv.io/forums) or [docs](http://openmv.io/docs). This README details how to setup the development environment to compile your OpenMV Cam's firmware.**
# Windows Installation # Windows Installation
There is no Windows development environment. It is very difficult to install the toolchain on Windows. Instead you can install Ubuntu on a virtual machine running on your windows machine: There is no Windows development environment. It is very difficult to install the toolchain on Windows. Instead you can install Ubuntu on a virtual machine running on your windows machine:
1. You can get VMware Player (free) [here](https://my.vmware.com/en/web/vmware/free#desktop_end_user_computing/vmware_workstation_player/15_0) to run Ubuntu. Or, you can get VirtualBox (free) [here](https://www.virtualbox.org/wiki/Downloads). VMware Player is reconmended. 1. You can get VMware Player (free) [here](https://my.vmware.com/en/web/vmware/free#desktop_end_user_computing/vmware_workstation_player/15_0) to run Ubuntu. Or, you can get VirtualBox (free) [here](https://www.virtualbox.org/wiki/Downloads). VMware Player is recommended.
2. Download Ubuntu [here](http://www.ubuntu.com/desktop). Then use whatever virtual machine software you installed to install the operating system. VMware Player makes this easy with a automated install option where it will install everything for you without you having to do anything other than enter your name and password initially. 2. Download Ubuntu [here](http://www.ubuntu.com/desktop). Then use whatever virtual machine software you installed to install the operating system. VMware Player makes this easy with a automated install option where it will install everything for you without you having to do anything other than enter your name and password initially.
3. Install any updates, etc. for your operating system. Also, if you're using VMware Player make sure to install VMware Tools so you can drag and drop files between your Windows desktop and Ubuntu desktop along with being able to setup shared folders. 3. Install any updates, etc. for your operating system. Also, if you're using VMware Player make sure to install VMware Tools so you can drag and drop files between your Windows desktop and Ubuntu desktop along with being able to setup shared folders.
@ -16,7 +16,7 @@ There is no Windows development environment. It is very difficult to install the
There is no Mac development environment. It is very difficult to install the toolchain on Mac. Instead you can install Ubuntu on a virtual machine running on your Mac machine: There is no Mac development environment. It is very difficult to install the toolchain on Mac. Instead you can install Ubuntu on a virtual machine running on your Mac machine:
1. You can get VMware Fusion (paid) [here](https://www.vmware.com/products/fusion/) to run Ubuntu. Or, you can get VirtualBox (free) [here](https://www.virtualbox.org/wiki/Downloads). VMware Fusion is reconmended. 1. You can get VMware Fusion (paid) [here](https://www.vmware.com/products/fusion/) to run Ubuntu. Or, you can get VirtualBox (free) [here](https://www.virtualbox.org/wiki/Downloads). VMware Fusion is recommended.
2. Download Ubuntu [here](http://www.ubuntu.com/desktop). Then use whatever virtual machine software you installed to install the operating system. VMware Fusion makes this easy with a automated install option where it will install everything for you without you having to do anything other than enter your name and password initially. 2. Download Ubuntu [here](http://www.ubuntu.com/desktop). Then use whatever virtual machine software you installed to install the operating system. VMware Fusion makes this easy with a automated install option where it will install everything for you without you having to do anything other than enter your name and password initially.
3. Install any updates, etc. for your operating system. Also, if you're using VMware Fusion make sure to install VMware Tools so you can drag and drop files between your Mac desktop and Ubuntu desktop along with being able to setup shared folders. 3. Install any updates, etc. for your operating system. Also, if you're using VMware Fusion make sure to install VMware Tools so you can drag and drop files between your Mac desktop and Ubuntu desktop along with being able to setup shared folders.
@ -56,17 +56,17 @@ Then:
git remote set-url origin https://github.com/<username>/micropython.git git remote set-url origin https://github.com/<username>/micropython.git
git remote add remote https://github.com/openmv/micropython.git git remote add remote https://github.com/openmv/micropython.git
This will setup the `openmv` and `micropython` repos so `origin` points to your forks and so you can pull updates from the offical repos with `remote`. Now when you want to create a new feature branch to send a Pull Request to OpenMV you just need to do: This will setup the `openmv` and `micropython` repos so `origin` points to your forks and so you can pull updates from the official repos with `remote`. Now when you want to create a new feature branch to send a Pull Request to OpenMV you just need to do:
git checkout -b <your_name>/<some_branch_name> git checkout -b <your_name>/<some_branch_name>
<commit changes> <commit changes>
git push origin -u <your_name>/<some_branch_name> git push origin -u <your_name>/<some_branch_name>
Finally, after pushing your changes you can then use Github to automatically generate a Pull Request to the offical OpenMV Github repo to get your changes upstreamed into the offical OpenMV Cam Firmware. Finally, after pushing your changes you can then use Github to automatically generate a Pull Request to the official OpenMV Github repo to get your changes upstreamed into the official OpenMV Cam Firmware.
### Committing Etiquette ### Committing Etiquette
If you would like to send a Pull Request to get your changes integrated into the offical source tree please try to keep one commit to one Pull Request. Additionally, please create example scripts (in `../scripts/examples`) for any new features you are committing. If you would like to send a Pull Request to get your changes integrated into the official source tree please try to keep one commit to one Pull Request. Additionally, please create example scripts (in `../scripts/examples`) for any new features you are committing.
# Work Flow # Work Flow