Skip to content

Commit e9d45ef

Browse files
committed
Copy up the License, Add a new README
1 parent 975879d commit e9d45ef

2 files changed

Lines changed: 64 additions & 0 deletions

File tree

LICENSE

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Copyright (c) Paradigm Hyperloop, 2017
2+
3+
This material is proprietary intellectual property of Paradigm Hyperloop.
4+
All rights reserved.
5+
6+
The methods and techniques described herein are considered proprietary
7+
information. Reproduction or distribution, in whole or in part, is
8+
forbidden without the express written permission of Paradigm Hyperloop.
9+
10+
Please send requests and inquiries to: [email protected]
11+
12+
Source that is published publicly is for demonstration purposes only and
13+
shall not be utilized to any extent without express written permission from
14+
Paradigm Hyperloop.
15+
16+
Please see https://paradigmhyperloop.com for additional information.
17+
18+
THIS SOFTWARE IS PROVIDED BY PARADIGM HYPERLOOP ''AS IS'' AND ANY
19+
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21+
DISCLAIMED. IN NO EVENT SHALL PARADIGM HYPERLOOP BE LIABLE FOR ANY
22+
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23+
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24+
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25+
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27+
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Paradigm Hyperloop
2+
3+
Comp III Control Software and Firmware.
4+
5+
## Important Documentation
6+
7+
- SpaceX Rules can be found [here](http://www.spacex.com/sites/spacex/files/2018_hyperloop_competition_rules.pdf)
8+
- Tube Specifications are continually being released. Check the Paradigm Hyperloop Google Drive for updated versions
9+
- Check the `Paradigm Hyperloop` > `04 Software` and `03 Electrical` folders for additional documentation, architecture specs, etc
10+
11+
## Firmware
12+
13+
Node board firmware is co-located in this repository to keep API implementation files consistent in the same git tree.
14+
15+
Firmware is currently developed using [platform.io](https://platform.io), but this is subject to change.
16+
17+
## Software
18+
19+
Software run on the BeageBone Black can be found in this repo as well.
20+
21+
## Testing
22+
23+
Testing is performed by a Jenkins build server automatically. Should your PR fail to build please have a look at the console output
24+
in the jenkins job for context clues. The Jenkins server executes the tasks listed in the `Jenkinsfile` and will test the Firmware and
25+
Embedded Software in various ways. You can reproduce those tests by following the steps in the `Jenkinsfile`.
26+
27+
# Contact
28+
29+
Please feel free to get in touch with us via [our contact form](https://paradigmhyperloop.com/contact/)
30+
31+
# People
32+
33+
Please check [our website](https://paradigmhyperloop.com) for our roster. Some of our members are also listed [here on Github](https://github.com/orgs/ParadigmHyperloop/people).
34+
35+
# License
36+
37+
See the [LICENSE](LICENSE) file found at the root of this repository and in the headers of our source code.

0 commit comments

Comments
 (0)