fe52c47570
This: * Re-organizes the docs into sections that align with what docs.filecoin.io becoming: * An installation section * A "getting started" section (lotus client focused) * A "storing" section (lotus client focused) * A "mining" section (miner focused) * A "build" section (developer focused) * An legacy "architecture" section is left in the last place. A few high-value documentation pages have been reviewed and updated with the latest recommendations: * Installation section and lotus setup * Miner setup * etc. ... Other pages have been correctly merged into the new relevant sections. Some pages have not been touched. The filesystem layout of the documentation has been changed into folders corresponding to the sections (as requested by @cw). Some pages that were not linked at all and/or where hidden, have been moved to "unclassified". This should make the porting of the Lotus documentation to docs.filecoin.io much easier, while ensuring it is more up to date than it was before. For the moment, this breaks most links as link-aliasing is not supported in lotus-docs. |
||
|---|---|---|
| .circleci | ||
| .github | ||
| api | ||
| build | ||
| chain | ||
| cli | ||
| cmd | ||
| conformance | ||
| documentation | ||
| extern | ||
| gen | ||
| genesis | ||
| journal | ||
| lib | ||
| lotuspond | ||
| markets | ||
| metrics | ||
| miner | ||
| node | ||
| paychmgr | ||
| scripts | ||
| storage | ||
| tools | ||
| .codecov.yml | ||
| .dockerignore | ||
| .gitignore | ||
| .gitmodules | ||
| .golangci.yml | ||
| CHANGELOG.md | ||
| go.mod | ||
| go.sum | ||
| LICENSE-APACHE | ||
| LICENSE-MIT | ||
| Makefile | ||
| README.md | ||
| SECURITY.md | ||
Project Lotus - 莲
Lotus is an implementation of the Filecoin Distributed Storage Network. For more details about Filecoin, check out the Filecoin Spec.
Building & Documentation
For instructions on how to build lotus from source, please visit https://lotu.sh or read the source here.
Reporting a Vulnerability
Please send an email to security@filecoin.org. See our security policy for more details.
Development
The main branches under development at the moment are:
master: current testnet.next: working branch with chain-breaking changes.ntwk-calibration: devnet running one ofnextcommits.
Tracker
All work is tracked via issues. An attempt at keeping an up-to-date view on remaining work towards Mainnet launch can be seen at the lotus github project board. The issues labeled with incentives are there to identify the issues needed for Space Race launch.
Packages
The lotus Filecoin implementation unfolds into the following packages:
- This repo
- go-fil-markets which has its own kanban work tracker available here
- spec-actors which has its own kanban work tracker available here
License
Dual-licensed under MIT + Apache 2.0