From b1ecd639a21eb73b185cbed66b1307f5d39ac529 Mon Sep 17 00:00:00 2001 From: Gabriele Contini <contini.mailing@gmail.com> Date: 周六, 14 3月 2020 23:40:30 +0800 Subject: [PATCH] docs with sphinx --- doc/analysis/Development-And-Usage-Workflow.md | 10 ++++++---- 1 files changed, 6 insertions(+), 4 deletions(-) diff --git a/doc/Development-And-Usage-Workflow.md b/doc/analysis/Development-And-Usage-Workflow.md similarity index 89% rename from doc/Development-And-Usage-Workflow.md rename to doc/analysis/Development-And-Usage-Workflow.md index bd44e5f..6cd5528 100644 --- a/doc/Development-And-Usage-Workflow.md +++ b/doc/analysis/Development-And-Usage-Workflow.md @@ -1,3 +1,5 @@ +# Development and usage workflow + Below a description of the planned development and usage process. Comments and progress are reported on [issue #42](https://github.com/open-license-manager/open-license-manager/issues/42)  @@ -8,7 +10,7 @@ ### Binary release contents Binary release contains: - * open-license-manager executable (merge of the actual `license_generator` executable and `bootstrap`). + * open-license-manager executable (`lcc`). * source code of the unconfigured library. * source code of (part of) the tests. @@ -18,7 +20,7 @@ In this phase the library is configured, compiled (only for the tests sake), linked with a mock executable and tested together with the license generator. ## Initialize library -In this phase the signing keys are generated by open-license-manager executable (`olm`), and optionally the source code of the library may be modified or obfuscated. +In this phase the signing keys are generated by open-license-manager executable (`lcc`), and optionally the source code of the library may be modified or obfuscated. ### Test (2) @@ -30,6 +32,6 @@ * If we want to link the execution to a specific hardware we need to send the product to the client without a license (or a demo executable, with the sole intent to generate the machine identifier). * If we just want to send a demo product with an expiry date we prepare a license without the machine identifier. -# Build process -From the process described above, (strange to say) the license generator (`olm`) configures itself as a build +## Build process +From the process described above, (strange to say) the license generator (`lcc`) configures itself as a build dependency of the licensing library, thus it needs to be built first. \ No newline at end of file -- Gitblit v1.9.1