Code Monkey home page Code Monkey logo

docs.theqrl.org's Introduction

QRL Documentation Page

Quantum Resistant Ledger

This is the documentation for the QRL project. The main project can be found at https://theQRL.org

This Github project is hosted at https://docs.theqrl.org

Contribute

We welcome contributors and believe in open source development

If you have good information to add to the documentation, please submit a PR. Anything from a typo to creating a complete write-up, the project and community will be better for it.


Building these docs

Install rvm

rvm install "ruby-2.7.2"
rvm use ruby-2.7.2
bundle install
gem install jekyll
bash _scripts/build.sh

Notes on building for Fedora 38

rvm pkg install openssl
rvm install ruby-2.7.2 --with-openssl-dir=$HOME/.rvm/usr

If the site builds without errors, check out the _site folder in a browser with a local server, e.g. http-server _site/ if http-server is globally installed npm i -g http-server

More information


docs.theqrl.org's People

Contributors

cyyber avatar dependabot[bot] avatar fr1t2 avatar imac318 avatar jackalyst avatar jleni avatar jplomas avatar scottdonaldau avatar surg0r avatar volt-mine avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

docs.theqrl.org's Issues

Cleanup Documentaion

FInd and kill any spelling errors, punctuation, and rewording that is needed in the documentation

API Documentation Cleanup

Epic for adding better API documentation to the site. Give examples of API use in multiple languages.

Unicode for the QRL

In order for QRL to reach the legitimate state of cryptocurrency, I thought that we needed a symbol for QRL unicode. In my opinion, the symbol can be shaped by combining binary numbers 0 and 1. The logo symbolizes quantum superposition state which simultaneously works as both 0 and 1.

Here's the sample for QRL unicode symbol ('shor' unit) that I've designed:

untitled diagram 4

e.g. https://en.bitcoin.it/wiki/Bitcoin_symbol

Update install docker command

Update the first command "Install QRL Node and dependencies" from:
docker pull qrledger/qrl-docker
to
docker pull qrledger/qrl-docker:bionic

TokenMigration

Adding documentation for the upcoming token migration phase.

Reformat header 3 ###

When using headers in the documentation header 3 highlights blue with an underline

Can we remove the blue and underline

Spelling mistake Ledger Nano S Initialising QRL App, and Init Device do not show on device

In the Ledger Nano S documentation page https://docs.theqrl.org/wallet/ledger-nano-s/
it reads "Ledger Nano S Initialising QRL App", should be "Ledger Nano S Initializing QRL App"

Further down on step 4. It says "Scroll down and press both buttons on the Init Device menu option." should be "Scroll down and press both buttons on the Init Tree menu option." as it shows on the ledger Nano S device

Note. This occurred on a new device setup today.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.