mirror of
https://github.com/corda/corda.git
synced 2025-02-20 17:33:15 +00:00
Merged in clint-readme (pull request #511)
Updated Readme, new license file and contributor file
This commit is contained in:
Clinton Alexander
commit
1660ec95b8
52
CONTRIBUTING.md
Normal file
52
CONTRIBUTING.md
Normal file
@ -0,0 +1,52 @@
|
||||
# Contributing to Corda
|
||||
|
||||
To start contributing you can fork our repo and begin making pull requests. Please use
|
||||
descriptive commit messages and follow our [coding style guidelines](https://docs.corda.net/codestyle.html).
|
||||
|
||||
## Community Locations
|
||||
|
||||
* [GitHub](https://github.com/corda/corda)
|
||||
* [Forums](https://discourse.corda.net)
|
||||
* [Chat](https://slack.corda.net)
|
||||
|
||||
## Developer Certificate of Origin
|
||||
|
||||
All contributions to this project are subject to the terms of the Developer Certificate of Origin, below:
|
||||
|
||||
Developer Certificate of Origin
|
||||
Version 1.1
|
||||
|
||||
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
|
||||
1 Letterman Drive
|
||||
Suite D4700
|
||||
San Francisco, CA, 94129
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies of this
|
||||
license document, but changing it is not allowed.
|
||||
|
||||
|
||||
Developer's Certificate of Origin 1.1
|
||||
|
||||
By making a contribution to this project, I certify that:
|
||||
|
||||
(a) The contribution was created in whole or in part by me and I
|
||||
have the right to submit it under the open source license
|
||||
indicated in the file; or
|
||||
|
||||
(b) The contribution is based upon previous work that, to the best
|
||||
of my knowledge, is covered under an appropriate open source
|
||||
license and I have the right under that license to submit that
|
||||
work with modifications, whether created in whole or in part
|
||||
by me, under the same open source license (unless I am
|
||||
permitted to submit under a different license), as indicated
|
||||
in the file; or
|
||||
|
||||
(c) The contribution was provided directly to me by some other
|
||||
person who certified (a), (b) or (c) and I have not modified
|
||||
it.
|
||||
|
||||
(d) I understand and agree that this project and the contribution
|
||||
are public and that a record of the contribution (including all
|
||||
personal information I submit with it, including my sign-off) is
|
||||
maintained indefinitely and may be redistributed consistent with
|
||||
this project or the open source license(s) involved.
|
||||
15
LICENCE
Normal file
15
LICENCE
Normal file
@ -0,0 +1,15 @@
|
||||
Copyright 2016, Distributed Ledger Group, LLC, a subsidiary of R3 HoldCo
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
||||
Corda and the Corda logo are trademarks of R3 HoldCo which may be registered in certain jurisdictions.*
|
||||
70
README.md
70
README.md
@ -1,48 +1,46 @@
|
||||
|
||||
|
||||
# Corda
|
||||
|
||||
Corda is a decentralised database system in which nodes trust each other as little as possible. This reference
|
||||
implementation is not yet complete or offering backwards compatibility, but should be suitable for small experiments
|
||||
and exploration of the underlying ideas.
|
||||
Corda is a decentralised database system in which nodes trust each other as little as possible.
|
||||
|
||||
## Features
|
||||
|
||||
* A P2P network of nodes.
|
||||
* Smart contracts.
|
||||
* Protocol framework.
|
||||
* "Notary" infrastructure to validate uniqueness of transactions.
|
||||
* Written as a platform for distributed apps called CorDapps.
|
||||
* Written in [Kotlin](https://kotlinlang.org), targeting the JVM.
|
||||
|
||||
Pull requests are appreciated. You can chat to the team on our forums and on our Slack.
|
||||
It runs on the JVM and is mostly written in Kotlin.
|
||||
Read our full and planned feature list [here](https://docs.corda.net/inthebox.html).
|
||||
|
||||
### **[Project website](https://corda.net)**
|
||||
## Useful links
|
||||
|
||||
### **[Documentation](https://docs.corda.net)**
|
||||
* [Getting started](https://docs.corda.net/getting-set-up.html)
|
||||
* [Writing a CorDapp](https://docs.corda.net/tutorial-cordapp.html)
|
||||
* [Project website](https://corda.net)
|
||||
* [Documentation](https://docs.corda.net)
|
||||
|
||||
## Development State
|
||||
|
||||
Corda is currently in very early development and should not be used in production systems. Breaking
|
||||
changes will happen on minor versions until 1.0. Experimentation with Corda is recommended.
|
||||
|
||||
Pull requests, experiments, and contributions are encouraged and welcomed.
|
||||
|
||||
## Background
|
||||
|
||||
The project is supported by R3, a financial industry consortium, which is why it
|
||||
contains some code for financial use cases and why the documentation focuses on finance. The goal is to use it
|
||||
to construct a global ledger, thus simplifying finance and reducing the overheads of banking. But it is run as
|
||||
a typical open source project and the basic technology of a peer to peer decentralised database may be useful
|
||||
for many different projects. We'd love to hear about any interesting experiments you do with it!
|
||||
to construct a global ledger, simplifying finance and reducing the overheads of banking. But it is run as
|
||||
an open source project and the basic technology of a peer to peer decentralised database may be useful
|
||||
for many different projects.
|
||||
|
||||
# Getting started
|
||||
## Contributing
|
||||
|
||||
Corda consists of node software that takes part in a network, libraries you can use to develop apps for the platform,
|
||||
a client library that lets you interact with the node via RPC, and some samples showing how it all works.
|
||||
Please read [here](./CONTRIBUTING.md).
|
||||
|
||||
To install:
|
||||
## License
|
||||
|
||||
1. Make sure you have Oracle JDK 8 available (OpenJDK 8 support is coming).
|
||||
2. Run `./gradlew install` to download all the dependencies (including the build tools), compile the code and
|
||||
install the core libraries into your local Maven repository (under `~/.m2`)
|
||||
|
||||
To run some demo nodes that swap cash around between themselves:
|
||||
|
||||
1. `./gradlew tools:explorer:runDemoNodes`
|
||||
2. You can find a node now running on port 20002
|
||||
|
||||
To run an explorer app that lets you connect to a node and explore what it's doing, try `./gradlew tools:explorer:run`.
|
||||
The explorer also lets you send and receive cash.
|
||||
|
||||
Now [go read the documentation](https://docs.corda.net).
|
||||
|
||||
# Getting involved
|
||||
|
||||
* [Forums](https://not.here.yet)
|
||||
* [Chat](https://cordaledger.slack.com)
|
||||
|
||||
# License
|
||||
|
||||
Apache 2.0
|
||||
[Apache 2.0](./LICENSE.md)
|
||||
9
docs/index.html
Normal file
9
docs/index.html
Normal file
@ -0,0 +1,9 @@
|
||||
<!-- HTML file for redirecting to the more nested docs file solely for convenience. -->
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0; url=./build/html/index.html" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Loading…
x
Reference in New Issue
Block a user