Skip to content
This repository has been archived by the owner on Sep 4, 2023. It is now read-only.

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
endlessloop2 committed May 22, 2019
1 parent 2dff46a commit f8cc062
Show file tree
Hide file tree
Showing 3 changed files with 121 additions and 63 deletions.
29 changes: 29 additions & 0 deletions README-es.md
@@ -0,0 +1,29 @@
Kepler v0.9.0.1
===============================

https://kepler.cash

Licencia
-------

Kepler Core is released under the terms of the MIT license. See [COPYING](COPYING) for more
information or see https://opensource.org/licenses/MIT.


Especificaciones Tecnicas
-------

* Emisión: ~ 31.000.000 KPL
* Preminado: 2%
* Algoritmos de minado: NeoScrypt, Argon2-4096, LyraCZ
* Tiempo de bloque: 2 minutos (6 minutos por algoritmo)
* **Puertos:**
* RPC: 12101
* P2P: 12102
* Block halving: Cada 4 años

Compilar
----------------
Vea [build-unix.md](doc/build-unix.md) o [build-windows.md](doc/build-windows.md) para más información.

[README ANTIGUO](README-old.md)
77 changes: 77 additions & 0 deletions README-old.md
@@ -0,0 +1,77 @@
Kepler Core staging tree 0.12.3
===============================

`master:` [![Build Status](https://travis-ci.org/keplerpay/kepler.svg?branch=master)](https://travis-ci.org/keplerpay/kepler) `develop:` [![Build Status](https://travis-ci.org/keplerpay/kepler.svg?branch=develop)](https://travis-ci.org/keplerpay/kepler/branches)

https://www.kepler.org


What is Kepler?
----------------

Kepler is an experimental digital currency that enables anonymous, instant
payments to anyone, anywhere in the world. Kepler uses peer-to-peer technology
to operate with no central authority: managing transactions and issuing money
are carried out collectively by the network. Kepler Core is the name of the open
source software which enables the use of this currency.

For more information, as well as an immediately useable, binary version of
the Kepler Core software, see https://www.kepler.org/get-kepler/.


License
-------

Kepler Core is released under the terms of the MIT license. See [COPYING](COPYING) for more
information or see https://opensource.org/licenses/MIT.

Development Process
-------------------

The `master` branch is meant to be stable. Development is normally done in separate branches.
[Tags](https://github.com/keplerpay/kepler/tags) are created to indicate new official,
stable release versions of Kepler Core.

The contribution workflow is described in [CONTRIBUTING.md](CONTRIBUTING.md).

Testing
-------

Testing and code review is the bottleneck for development; we get more pull
requests than we can review and test on short notice. Please be patient and help out by testing
other people's pull requests, and remember this is a security-critical project where any mistake might cost people
lots of money.

### Automated Testing

Developers are strongly encouraged to write [unit tests](src/test/README.md) for new code, and to
submit new unit tests for old code. Unit tests can be compiled and run
(assuming they weren't disabled in configure) with: `make check`. Further details on running
and extending unit tests can be found in [/src/test/README.md](/src/test/README.md).

There are also [regression and integration tests](/qa) of the RPC interface, written
in Python, that are run automatically on the build server.
These tests can be run (if the [test dependencies](/qa) are installed) with: `qa/pull-tester/rpc-tests.py`

The Travis CI system makes sure that every pull request is built for Windows, Linux, and OS X, and that unit/sanity tests are run automatically.

### Manual Quality Assurance (QA) Testing

Changes should be tested by somebody other than the developer who wrote the
code. This is especially important for large or high-risk changes. It is useful
to add a test plan to the pull request description if testing the changes is
not straightforward.

Translations
------------

Changes to translations as well as new translations can be submitted to
[Kepler Core's Transifex page](https://www.transifex.com/projects/p/kepler/).

Translations are periodically pulled from Transifex and merged into the git repository. See the
[translation process](doc/translation_process.md) for details on how this works.

**Important**: We do not accept translation changes as GitHub pull requests because the next
pull from Transifex would automatically overwrite them again.

Translators should also follow the [forum](https://www.kepler.org/forum/topic/kepler-worldwide-collaboration.88/).
78 changes: 15 additions & 63 deletions README.md
@@ -1,77 +1,29 @@
Kepler Core staging tree 0.12.3
Kepler v0.9.0.1
===============================

`master:` [![Build Status](https://travis-ci.org/keplerpay/kepler.svg?branch=master)](https://travis-ci.org/keplerpay/kepler) `develop:` [![Build Status](https://travis-ci.org/keplerpay/kepler.svg?branch=develop)](https://travis-ci.org/keplerpay/kepler/branches)

https://www.kepler.org


What is Kepler?
----------------

Kepler is an experimental digital currency that enables anonymous, instant
payments to anyone, anywhere in the world. Kepler uses peer-to-peer technology
to operate with no central authority: managing transactions and issuing money
are carried out collectively by the network. Kepler Core is the name of the open
source software which enables the use of this currency.

For more information, as well as an immediately useable, binary version of
the Kepler Core software, see https://www.kepler.org/get-kepler/.

https://kepler.cash

License
-------

Kepler Core is released under the terms of the MIT license. See [COPYING](COPYING) for more
information or see https://opensource.org/licenses/MIT.

Development Process
-------------------

The `master` branch is meant to be stable. Development is normally done in separate branches.
[Tags](https://github.com/keplerpay/kepler/tags) are created to indicate new official,
stable release versions of Kepler Core.

The contribution workflow is described in [CONTRIBUTING.md](CONTRIBUTING.md).

Testing
Technical Specifications
-------

Testing and code review is the bottleneck for development; we get more pull
requests than we can review and test on short notice. Please be patient and help out by testing
other people's pull requests, and remember this is a security-critical project where any mistake might cost people
lots of money.

### Automated Testing
* Emission: ~ 31,000,000 KPL
* Premine: 2%
* Mining Algorithms: NeoScrypt, Argon2-4096, LyraCZ
* Block time: 2 minutes (6 minutes per algorithm)
* **Ports:**
* RPC: 12101
* P2P: 12102
* Block halving: Every 4 years

Developers are strongly encouraged to write [unit tests](src/test/README.md) for new code, and to
submit new unit tests for old code. Unit tests can be compiled and run
(assuming they weren't disabled in configure) with: `make check`. Further details on running
and extending unit tests can be found in [/src/test/README.md](/src/test/README.md).

There are also [regression and integration tests](/qa) of the RPC interface, written
in Python, that are run automatically on the build server.
These tests can be run (if the [test dependencies](/qa) are installed) with: `qa/pull-tester/rpc-tests.py`

The Travis CI system makes sure that every pull request is built for Windows, Linux, and OS X, and that unit/sanity tests are run automatically.

### Manual Quality Assurance (QA) Testing

Changes should be tested by somebody other than the developer who wrote the
code. This is especially important for large or high-risk changes. It is useful
to add a test plan to the pull request description if testing the changes is
not straightforward.

Translations
------------

Changes to translations as well as new translations can be submitted to
[Kepler Core's Transifex page](https://www.transifex.com/projects/p/kepler/).

Translations are periodically pulled from Transifex and merged into the git repository. See the
[translation process](doc/translation_process.md) for details on how this works.

**Important**: We do not accept translation changes as GitHub pull requests because the next
pull from Transifex would automatically overwrite them again.
Compilation process
----------------
See [build-unix.md](doc/build-unix.md) or [build-windows.md](doc/build-windows.md) for more information.

Translators should also follow the [forum](https://www.kepler.org/forum/topic/kepler-worldwide-collaboration.88/).
[OLD README](README-old.md)

0 comments on commit f8cc062

Please sign in to comment.