From d60585da0c0ea9522ffcae304728693239fe6478 Mon Sep 17 00:00:00 2001 From: NotRin7 <102989232+NotRin7@users.noreply.github.com> Date: Fri, 15 Mar 2024 18:34:04 +0100 Subject: [PATCH] Update README.md --- README.md | 76 +++++++++++++------------------------------------------ 1 file changed, 18 insertions(+), 58 deletions(-) diff --git a/README.md b/README.md index af9401d..260d9ea 100644 --- a/README.md +++ b/README.md @@ -1,75 +1,35 @@ -Palladium Core integration/staging tree -===================================== +Palladium Coin Core Integration/Staging Tree +https://palladiumcoin.com -https://palladiumcore.org +What is Palladium Coin? +Palladium Coin is an innovative digital currency designed for instant transactions globally. Operating without a central authority, Palladium Coin utilizes peer-to-peer technology for transaction management and currency issuance. Palladium Coin Core serves as the foundational open-source software facilitating the use of this cryptocurrency. -What is Palladium? ----------------- - -Palladium is an experimental digital currency that enables instant payments to -anyone, anywhere in the world. Palladium uses peer-to-peer technology to operate -with no central authority: managing transactions and issuing money are carried -out collectively by the network. Palladium Core is the name of open source -software which enables the use of this currency. - -For more information, as well as an immediately usable, binary version of -the Palladium Core software, see https://palladiumcore.org/en/download/, or read the -[original whitepaper](https://palladiumcore.org/palladium.pdf). +For further details and to access the binary version of Palladium Coin Core software, visit https://palladiumcoin.com/en/download/, or refer to the original whitepaper. License -------- - -Palladium Core is released under the terms of the MIT license. See [COPYING](COPYING) for more -information or see https://opensource.org/licenses/MIT. +Palladium Coin Core is released under the MIT license terms. Refer to COPYING for comprehensive details or visit https://opensource.org/licenses/MIT. Development Process -------------------- +While the master branch undergoes regular builds and testing, stability cannot be guaranteed. Periodic tags signify new official and stable releases of Palladium Coin Core. -The `master` branch is regularly built and tested, but is not guaranteed to be -completely stable. [Tags](https://github.com/palladium/palladium/tags) are created -regularly to indicate new official, stable release versions of Palladium Core. - -The contribution workflow is described in [CONTRIBUTING.md](CONTRIBUTING.md) -and useful hints for developers can be found in [doc/developer-notes.md](doc/developer-notes.md). +The contribution process is outlined in CONTRIBUTING.md, while developers can find valuable insights in doc/developer-notes.md. Testing -------- +Testing and code review constitute critical aspects of development. We encourage community participation in testing pull requests to ensure robustness and security. -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 urged to incorporate unit tests for new code and enhance existing code coverage. Unit tests can be executed with: make check (assuming they're enabled in configure). Detailed instructions on running and expanding unit tests are available in /src/test/README.md. -### Automated Testing +Regression and integration tests, scripted in Python, are automatically executed on the build server. To run these tests (after installing test dependencies): test/functional/test_runner.py -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). +Travis CI ensures each pull request undergoes builds for Windows, Linux, and macOS, with automatic execution of unit/sanity tests. -There are also [regression and integration tests](/test), written -in Python, that are run automatically on the build server. -These tests can be run (if the [test dependencies](/test) are installed) with: `test/functional/test_runner.py` - -The Travis CI system makes sure that every pull request is built for Windows, Linux, and macOS, 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. +Manual Quality Assurance (QA) Testing +It's essential that changes undergo testing by individuals other than the code author, especially for significant or high-risk alterations. If testing isn't straightforward, it's advisable to include a test plan in the pull request description. Translations ------------- +Translations and updates can be submitted via Palladium Coin Core's Transifex page. -Changes to translations as well as new translations can be submitted to -[Palladium Core's Transifex page](https://www.transifex.com/palladium/palladium/). +Translations are periodically merged into the git repository from Transifex. Refer to the translation process for insights into this workflow. -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 subscribe to the [mailing list](https://groups.google.com/forum/#!forum/palladium-translators). +Note: Translation changes shouldn't be submitted as GitHub pull requests to avoid automatic overwriting during the next Transifex pull. Translators are encouraged to subscribe to the mailing list for updates.